use anyhow::Context;
use globset::{GlobBuilder, GlobSet, GlobSetBuilder};
use itertools::Itertools;
use regex::Regex;
use serde::{Deserialize, Serialize};
use std::borrow::Cow;
use std::cmp::Ordering;
use std::error::Error;
use std::fmt::{Display, Formatter};
use std::mem;
use std::path::StripPrefixError;
use std::sync::{Arc, OnceLock};
use std::{
ffi::OsStr,
path::{Path, PathBuf},
sync::LazyLock,
};
use crate::rel_path::RelPathBuf;
use crate::{rel_path::RelPath, shell::ShellKind};
static HOME_DIR: OnceLock<PathBuf> = OnceLock::new();
pub fn home_dir() -> &'static PathBuf {
HOME_DIR.get_or_init(|| {
if cfg!(any(test, feature = "test-support")) {
if cfg!(target_os = "macos") {
PathBuf::from("/Users/zed")
} else if cfg!(target_os = "windows") {
PathBuf::from("C:\\Users\\zed")
} else {
PathBuf::from("/home/zed")
}
} else {
dirs::home_dir().expect("failed to determine home directory")
}
})
}
pub trait PathExt {
fn compact(&self) -> PathBuf;
fn extension_or_hidden_file_name(&self) -> Option<&str>;
fn try_from_bytes<'a>(bytes: &'a [u8]) -> anyhow::Result<Self>
where
Self: From<&'a Path>,
{
#[cfg(unix)]
{
use std::os::unix::prelude::OsStrExt;
Ok(Self::from(Path::new(OsStr::from_bytes(bytes))))
}
#[cfg(windows)]
{
use tendril::fmt::{Format, WTF8};
WTF8::validate(bytes)
.then(|| {
Self::from(Path::new(unsafe {
OsStr::from_encoded_bytes_unchecked(bytes)
}))
})
.with_context(|| format!("Invalid WTF-8 sequence: {bytes:?}"))
}
}
fn local_to_wsl(&self) -> Option<PathBuf>;
fn multiple_extensions(&self) -> Option<String>;
fn try_shell_safe(&self, shell_kind: ShellKind) -> anyhow::Result<String>;
}
impl<T: AsRef<Path>> PathExt for T {
fn compact(&self) -> PathBuf {
if cfg!(any(target_os = "linux", target_os = "freebsd")) || cfg!(target_os = "macos") {
match self.as_ref().strip_prefix(home_dir().as_path()) {
Ok(relative_path) => {
let mut shortened_path = PathBuf::new();
shortened_path.push("~");
shortened_path.push(relative_path);
shortened_path
}
Err(_) => self.as_ref().to_path_buf(),
}
} else {
self.as_ref().to_path_buf()
}
}
fn extension_or_hidden_file_name(&self) -> Option<&str> {
let path = self.as_ref();
let file_name = path.file_name()?.to_str()?;
if file_name.starts_with('.') {
return file_name.strip_prefix('.');
}
path.extension()
.and_then(|e| e.to_str())
.or_else(|| path.file_stem()?.to_str())
}
fn local_to_wsl(&self) -> Option<PathBuf> {
let mut new_path = std::ffi::OsString::new();
for component in self.as_ref().components() {
match component {
std::path::Component::Prefix(prefix) => {
let drive_letter = prefix.as_os_str().to_string_lossy().to_lowercase();
let drive_letter = drive_letter.strip_suffix(':')?;
new_path.push(format!("/mnt/{}", drive_letter));
}
std::path::Component::RootDir => {}
std::path::Component::CurDir => {
new_path.push("/.");
}
std::path::Component::ParentDir => {
new_path.push("/..");
}
std::path::Component::Normal(os_str) => {
new_path.push("/");
new_path.push(os_str);
}
}
}
Some(new_path.into())
}
fn multiple_extensions(&self) -> Option<String> {
let path = self.as_ref();
let file_name = path.file_name()?.to_str()?;
let parts: Vec<&str> = file_name
.split('.')
.skip(1)
.collect();
if parts.len() < 2 {
return None;
}
Some(parts.into_iter().join("."))
}
fn try_shell_safe(&self, shell_kind: ShellKind) -> anyhow::Result<String> {
let path_str = self
.as_ref()
.to_str()
.with_context(|| "Path contains invalid UTF-8")?;
shell_kind
.try_quote(path_str)
.as_deref()
.map(ToOwned::to_owned)
.context("Failed to quote path")
}
}
pub fn path_ends_with(base: &Path, suffix: &Path) -> bool {
strip_path_suffix(base, suffix).is_some()
}
pub fn strip_path_suffix<'a>(base: &'a Path, suffix: &Path) -> Option<&'a Path> {
if let Some(remainder) = base
.as_os_str()
.as_encoded_bytes()
.strip_suffix(suffix.as_os_str().as_encoded_bytes())
{
if remainder
.last()
.is_none_or(|last_byte| std::path::is_separator(*last_byte as char))
{
let os_str = unsafe {
OsStr::from_encoded_bytes_unchecked(
&remainder[0..remainder.len().saturating_sub(1)],
)
};
return Some(Path::new(os_str));
}
}
None
}
#[derive(Eq, PartialEq, Hash, Ord, PartialOrd)]
#[repr(transparent)]
pub struct SanitizedPath(Path);
impl SanitizedPath {
pub fn new<T: AsRef<Path> + ?Sized>(path: &T) -> &Self {
#[cfg(not(target_os = "windows"))]
return Self::unchecked_new(path.as_ref());
#[cfg(target_os = "windows")]
return Self::unchecked_new(dunce::simplified(path.as_ref()));
}
pub fn unchecked_new<T: AsRef<Path> + ?Sized>(path: &T) -> &Self {
unsafe { mem::transmute::<&Path, &Self>(path.as_ref()) }
}
pub fn from_arc(path: Arc<Path>) -> Arc<Self> {
#[cfg(not(target_os = "windows"))]
return unsafe { mem::transmute::<Arc<Path>, Arc<Self>>(path) };
#[cfg(target_os = "windows")]
{
let simplified = dunce::simplified(path.as_ref());
if simplified == path.as_ref() {
unsafe { mem::transmute::<Arc<Path>, Arc<Self>>(path) }
} else {
Self::unchecked_new(simplified).into()
}
}
}
pub fn new_arc<T: AsRef<Path> + ?Sized>(path: &T) -> Arc<Self> {
Self::new(path).into()
}
pub fn cast_arc(path: Arc<Self>) -> Arc<Path> {
unsafe { mem::transmute::<Arc<Self>, Arc<Path>>(path) }
}
pub fn cast_arc_ref(path: &Arc<Self>) -> &Arc<Path> {
unsafe { mem::transmute::<&Arc<Self>, &Arc<Path>>(path) }
}
pub fn starts_with(&self, prefix: &Self) -> bool {
self.0.starts_with(&prefix.0)
}
pub fn as_path(&self) -> &Path {
&self.0
}
pub fn file_name(&self) -> Option<&std::ffi::OsStr> {
self.0.file_name()
}
pub fn extension(&self) -> Option<&std::ffi::OsStr> {
self.0.extension()
}
pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
self.0.join(path)
}
pub fn parent(&self) -> Option<&Self> {
self.0.parent().map(Self::unchecked_new)
}
pub fn strip_prefix(&self, base: &Self) -> Result<&Path, StripPrefixError> {
self.0.strip_prefix(base.as_path())
}
pub fn to_str(&self) -> Option<&str> {
self.0.to_str()
}
pub fn to_path_buf(&self) -> PathBuf {
self.0.to_path_buf()
}
}
impl std::fmt::Debug for SanitizedPath {
fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
std::fmt::Debug::fmt(&self.0, formatter)
}
}
impl Display for SanitizedPath {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0.display())
}
}
impl From<&SanitizedPath> for Arc<SanitizedPath> {
fn from(sanitized_path: &SanitizedPath) -> Self {
let path: Arc<Path> = sanitized_path.0.into();
unsafe { mem::transmute(path) }
}
}
impl From<&SanitizedPath> for PathBuf {
fn from(sanitized_path: &SanitizedPath) -> Self {
sanitized_path.as_path().into()
}
}
impl AsRef<Path> for SanitizedPath {
fn as_ref(&self) -> &Path {
&self.0
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum PathStyle {
Posix,
Windows,
}
impl PathStyle {
#[cfg(target_os = "windows")]
pub const fn local() -> Self {
PathStyle::Windows
}
#[cfg(not(target_os = "windows"))]
pub const fn local() -> Self {
PathStyle::Posix
}
#[inline]
pub fn primary_separator(&self) -> &'static str {
match self {
PathStyle::Posix => "/",
PathStyle::Windows => "\\",
}
}
pub fn separators(&self) -> &'static [&'static str] {
match self {
PathStyle::Posix => &["/"],
PathStyle::Windows => &["\\", "/"],
}
}
pub fn separators_ch(&self) -> &'static [char] {
match self {
PathStyle::Posix => &['/'],
PathStyle::Windows => &['\\', '/'],
}
}
pub fn is_windows(&self) -> bool {
*self == PathStyle::Windows
}
pub fn is_posix(&self) -> bool {
*self == PathStyle::Posix
}
pub fn join(self, left: impl AsRef<Path>, right: impl AsRef<Path>) -> Option<String> {
let right = right.as_ref().to_str()?;
if is_absolute(right, self) {
return None;
}
let left = left.as_ref().to_str()?;
if left.is_empty() {
Some(right.into())
} else {
Some(format!(
"{left}{}{right}",
if left.ends_with(self.primary_separator()) {
""
} else {
self.primary_separator()
}
))
}
}
pub fn split(self, path_like: &str) -> (Option<&str>, &str) {
let Some(pos) = path_like.rfind(self.primary_separator()) else {
return (None, path_like);
};
let filename_start = pos + self.primary_separator().len();
(
Some(&path_like[..filename_start]),
&path_like[filename_start..],
)
}
pub fn strip_prefix<'a>(
&self,
child: &'a Path,
parent: &'a Path,
) -> Option<std::borrow::Cow<'a, RelPath>> {
let parent = parent.to_str()?;
if parent.is_empty() {
return RelPath::new(child, *self).ok();
}
let parent = self
.separators()
.iter()
.find_map(|sep| parent.strip_suffix(sep))
.unwrap_or(parent);
let child = child.to_str()?;
let stripped = child.strip_prefix(parent)?;
if let Some(relative) = self
.separators()
.iter()
.find_map(|sep| stripped.strip_prefix(sep))
{
RelPath::new(relative.as_ref(), *self).ok()
} else if stripped.is_empty() {
Some(Cow::Borrowed(RelPath::empty()))
} else {
None
}
}
}
#[derive(Debug, Clone)]
pub struct RemotePathBuf {
style: PathStyle,
string: String,
}
impl RemotePathBuf {
pub fn new(string: String, style: PathStyle) -> Self {
Self { style, string }
}
pub fn from_str(path: &str, style: PathStyle) -> Self {
Self::new(path.to_string(), style)
}
pub fn path_style(&self) -> PathStyle {
self.style
}
pub fn to_proto(self) -> String {
self.string
}
}
impl Display for RemotePathBuf {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.string)
}
}
pub fn is_absolute(path_like: &str, path_style: PathStyle) -> bool {
path_like.starts_with('/')
|| path_style == PathStyle::Windows
&& (path_like.starts_with('\\')
|| path_like
.chars()
.next()
.is_some_and(|c| c.is_ascii_alphabetic())
&& path_like[1..]
.strip_prefix(':')
.is_some_and(|path| path.starts_with('/') || path.starts_with('\\')))
}
#[derive(Debug, PartialEq)]
#[non_exhaustive]
pub struct NormalizeError;
impl Error for NormalizeError {}
impl std::fmt::Display for NormalizeError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("parent reference `..` points outside of base directory")
}
}
pub fn normalize_lexically(path: &Path) -> Result<PathBuf, NormalizeError> {
use std::path::Component;
let mut lexical = PathBuf::new();
let mut iter = path.components().peekable();
let root = match iter.peek() {
Some(Component::ParentDir) => return Err(NormalizeError),
Some(p @ Component::RootDir) | Some(p @ Component::CurDir) => {
lexical.push(p);
iter.next();
lexical.as_os_str().len()
}
Some(Component::Prefix(prefix)) => {
lexical.push(prefix.as_os_str());
iter.next();
if let Some(p @ Component::RootDir) = iter.peek() {
lexical.push(p);
iter.next();
}
lexical.as_os_str().len()
}
None => return Ok(PathBuf::new()),
Some(Component::Normal(_)) => 0,
};
for component in iter {
match component {
Component::RootDir => unreachable!(),
Component::Prefix(_) => return Err(NormalizeError),
Component::CurDir => continue,
Component::ParentDir => {
if lexical.as_os_str().len() == root {
return Err(NormalizeError);
} else {
lexical.pop();
}
}
Component::Normal(path) => lexical.push(path),
}
}
Ok(lexical)
}
pub const FILE_ROW_COLUMN_DELIMITER: char = ':';
const ROW_COL_CAPTURE_REGEX: &str = r"(?xs)
([^\(]+)\:(?:
\((\d+)[,:](\d+)\) # filename:(row,column), filename:(row:column)
|
\((\d+)\)() # filename:(row)
)
|
([^\(]+)(?:
\((\d+)[,:](\d+)\) # filename(row,column), filename(row:column)
|
\((\d+)\)() # filename(row)
)
|
(.+?)(?:
\:+(\d+)\:(\d+)\:*$ # filename:row:column
|
\:+(\d+)\:*()$ # filename:row
|
\:+()()$
)";
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
pub struct PathWithPosition {
pub path: PathBuf,
pub row: Option<u32>,
pub column: Option<u32>,
}
impl PathWithPosition {
pub fn from_path(path: PathBuf) -> Self {
Self {
path,
row: None,
column: None,
}
}
pub fn parse_str(s: &str) -> Self {
let trimmed = s.trim();
let path = Path::new(trimmed);
let Some(maybe_file_name_with_row_col) = path.file_name().unwrap_or_default().to_str()
else {
return Self {
path: Path::new(s).to_path_buf(),
row: None,
column: None,
};
};
if maybe_file_name_with_row_col.is_empty() {
return Self {
path: Path::new(s).to_path_buf(),
row: None,
column: None,
};
}
static SUFFIX_RE: LazyLock<Regex> =
LazyLock::new(|| Regex::new(ROW_COL_CAPTURE_REGEX).unwrap());
match SUFFIX_RE
.captures(maybe_file_name_with_row_col)
.map(|caps| caps.extract())
{
Some((_, [file_name, maybe_row, maybe_column])) => {
let row = maybe_row.parse::<u32>().ok();
let column = maybe_column.parse::<u32>().ok();
let (_, suffix) = trimmed.split_once(file_name).unwrap();
let path_without_suffix = &trimmed[..trimmed.len() - suffix.len()];
Self {
path: Path::new(path_without_suffix).to_path_buf(),
row,
column,
}
}
None => {
let delimiter = ':';
let mut path_parts = s
.rsplitn(3, delimiter)
.collect::<Vec<_>>()
.into_iter()
.rev()
.fuse();
let mut path_string = path_parts.next().expect("rsplitn should have the rest of the string as its last parameter that we reversed").to_owned();
let mut row = None;
let mut column = None;
if let Some(maybe_row) = path_parts.next() {
if let Ok(parsed_row) = maybe_row.parse::<u32>() {
row = Some(parsed_row);
if let Some(parsed_column) = path_parts
.next()
.and_then(|maybe_col| maybe_col.parse::<u32>().ok())
{
column = Some(parsed_column);
}
} else {
path_string.push(delimiter);
path_string.push_str(maybe_row);
}
}
for split in path_parts {
path_string.push(delimiter);
path_string.push_str(split);
}
Self {
path: PathBuf::from(path_string),
row,
column,
}
}
}
}
pub fn map_path<E>(
self,
mapping: impl FnOnce(PathBuf) -> Result<PathBuf, E>,
) -> Result<PathWithPosition, E> {
Ok(PathWithPosition {
path: mapping(self.path)?,
row: self.row,
column: self.column,
})
}
pub fn to_string(&self, path_to_string: impl Fn(&PathBuf) -> String) -> String {
let path_string = path_to_string(&self.path);
if let Some(row) = self.row {
if let Some(column) = self.column {
format!("{path_string}:{row}:{column}")
} else {
format!("{path_string}:{row}")
}
} else {
path_string
}
}
}
#[derive(Clone)]
pub struct PathMatcher {
sources: Vec<(String, RelPathBuf, /*trailing separator*/ bool)>,
glob: GlobSet,
path_style: PathStyle,
}
impl std::fmt::Debug for PathMatcher {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("PathMatcher")
.field("sources", &self.sources)
.field("path_style", &self.path_style)
.finish()
}
}
impl PartialEq for PathMatcher {
fn eq(&self, other: &Self) -> bool {
self.sources.eq(&other.sources)
}
}
impl Eq for PathMatcher {}
impl PathMatcher {
pub fn new(
globs: impl IntoIterator<Item = impl AsRef<str>>,
path_style: PathStyle,
) -> Result<Self, globset::Error> {
let globs = globs
.into_iter()
.map(|as_str| {
GlobBuilder::new(as_str.as_ref())
.backslash_escape(path_style.is_posix())
.build()
})
.collect::<Result<Vec<_>, _>>()?;
let sources = globs
.iter()
.filter_map(|glob| {
let glob = glob.glob();
Some((
glob.to_string(),
RelPath::new(&glob.as_ref(), path_style)
.ok()
.map(std::borrow::Cow::into_owned)?,
glob.ends_with(path_style.separators_ch()),
))
})
.collect();
let mut glob_builder = GlobSetBuilder::new();
for single_glob in globs {
glob_builder.add(single_glob);
}
let glob = glob_builder.build()?;
Ok(PathMatcher {
glob,
sources,
path_style,
})
}
pub fn sources(&self) -> impl Iterator<Item = &str> + Clone {
self.sources.iter().map(|(source, ..)| source.as_str())
}
pub fn is_match<P: AsRef<RelPath>>(&self, other: P) -> bool {
let other = other.as_ref();
if self
.sources
.iter()
.any(|(_, source, _)| other.starts_with(source) || other.ends_with(source))
{
return true;
}
let other_path = other.display(self.path_style);
if self.glob.is_match(&*other_path) {
return true;
}
self.glob
.is_match(other_path.into_owned() + self.path_style.primary_separator())
}
pub fn is_match_std_path<P: AsRef<Path>>(&self, other: P) -> bool {
let other = other.as_ref();
if self.sources.iter().any(|(_, source, _)| {
other.starts_with(source.as_std_path()) || other.ends_with(source.as_std_path())
}) {
return true;
}
self.glob.is_match(other)
}
}
impl Default for PathMatcher {
fn default() -> Self {
Self {
path_style: PathStyle::local(),
glob: GlobSet::empty(),
sources: vec![],
}
}
}
fn compare_numeric_segments<I>(
a_iter: &mut std::iter::Peekable<I>,
b_iter: &mut std::iter::Peekable<I>,
) -> Ordering
where
I: Iterator<Item = char>,
{
let mut a_num_str = String::new();
let mut b_num_str = String::new();
while let Some(&c) = a_iter.peek() {
if !c.is_ascii_digit() {
break;
}
a_num_str.push(c);
a_iter.next();
}
while let Some(&c) = b_iter.peek() {
if !c.is_ascii_digit() {
break;
}
b_num_str.push(c);
b_iter.next();
}
match a_num_str.len().cmp(&b_num_str.len()) {
Ordering::Equal => {
match a_num_str.cmp(&b_num_str) {
Ordering::Equal => Ordering::Equal,
ordering => ordering,
}
}
ordering => {
if let (Ok(a_val), Ok(b_val)) = (a_num_str.parse::<u128>(), b_num_str.parse::<u128>()) {
match a_val.cmp(&b_val) {
Ordering::Equal => ordering, ord => ord,
}
} else {
a_num_str.cmp(&b_num_str)
}
}
}
}
pub fn natural_sort(a: &str, b: &str) -> Ordering {
let mut a_iter = a.chars().peekable();
let mut b_iter = b.chars().peekable();
loop {
match (a_iter.peek(), b_iter.peek()) {
(None, None) => {
return b.cmp(a);
}
(None, _) => return Ordering::Less,
(_, None) => return Ordering::Greater,
(Some(&a_char), Some(&b_char)) => {
if a_char.is_ascii_digit() && b_char.is_ascii_digit() {
match compare_numeric_segments(&mut a_iter, &mut b_iter) {
Ordering::Equal => continue,
ordering => return ordering,
}
} else {
match a_char
.to_ascii_lowercase()
.cmp(&b_char.to_ascii_lowercase())
{
Ordering::Equal => {
a_iter.next();
b_iter.next();
}
ordering => return ordering,
}
}
}
}
}
}
fn natural_sort_no_tiebreak(a: &str, b: &str) -> Ordering {
if a.eq_ignore_ascii_case(b) {
Ordering::Equal
} else {
natural_sort(a, b)
}
}
fn stem_and_extension(filename: &str) -> (Option<&str>, Option<&str>) {
if filename.is_empty() {
return (None, None);
}
match filename.rsplit_once('.') {
None => (Some(filename), None),
Some((before, after)) => {
if before.is_empty() {
(Some(filename), None)
} else {
(Some(before), Some(after))
}
}
}
}
pub fn compare_rel_paths(
(path_a, a_is_file): (&RelPath, bool),
(path_b, b_is_file): (&RelPath, bool),
) -> Ordering {
let mut components_a = path_a.components();
let mut components_b = path_b.components();
loop {
match (components_a.next(), components_b.next()) {
(Some(component_a), Some(component_b)) => {
let a_is_file = a_is_file && components_a.rest().is_empty();
let b_is_file = b_is_file && components_b.rest().is_empty();
let ordering = a_is_file.cmp(&b_is_file).then_with(|| {
let (a_stem, a_extension) = a_is_file
.then(|| stem_and_extension(component_a))
.unwrap_or_default();
let path_string_a = if a_is_file { a_stem } else { Some(component_a) };
let (b_stem, b_extension) = b_is_file
.then(|| stem_and_extension(component_b))
.unwrap_or_default();
let path_string_b = if b_is_file { b_stem } else { Some(component_b) };
let compare_components = match (path_string_a, path_string_b) {
(Some(a), Some(b)) => natural_sort(&a, &b),
(Some(_), None) => Ordering::Greater,
(None, Some(_)) => Ordering::Less,
(None, None) => Ordering::Equal,
};
compare_components.then_with(|| {
if a_is_file && b_is_file {
let ext_a = a_extension.unwrap_or_default();
let ext_b = b_extension.unwrap_or_default();
ext_a.cmp(ext_b)
} else {
Ordering::Equal
}
})
});
if !ordering.is_eq() {
return ordering;
}
}
(Some(_), None) => break Ordering::Greater,
(None, Some(_)) => break Ordering::Less,
(None, None) => break Ordering::Equal,
}
}
}
pub fn compare_rel_paths_mixed(
(path_a, a_is_file): (&RelPath, bool),
(path_b, b_is_file): (&RelPath, bool),
) -> Ordering {
let original_paths_equal = std::ptr::eq(path_a, path_b) || path_a == path_b;
let mut components_a = path_a.components();
let mut components_b = path_b.components();
loop {
match (components_a.next(), components_b.next()) {
(Some(component_a), Some(component_b)) => {
let a_leaf_file = a_is_file && components_a.rest().is_empty();
let b_leaf_file = b_is_file && components_b.rest().is_empty();
let (a_stem, a_ext) = a_leaf_file
.then(|| stem_and_extension(component_a))
.unwrap_or_default();
let (b_stem, b_ext) = b_leaf_file
.then(|| stem_and_extension(component_b))
.unwrap_or_default();
let a_key = if a_leaf_file {
a_stem
} else {
Some(component_a)
};
let b_key = if b_leaf_file {
b_stem
} else {
Some(component_b)
};
let ordering = match (a_key, b_key) {
(Some(a), Some(b)) => natural_sort_no_tiebreak(a, b)
.then_with(|| match (a_leaf_file, b_leaf_file) {
(true, false) if a == b => Ordering::Greater,
(false, true) if a == b => Ordering::Less,
_ => Ordering::Equal,
})
.then_with(|| {
if a_leaf_file && b_leaf_file {
let a_ext_str = a_ext.unwrap_or_default().to_lowercase();
let b_ext_str = b_ext.unwrap_or_default().to_lowercase();
b_ext_str.cmp(&a_ext_str)
} else {
Ordering::Equal
}
}),
(Some(_), None) => Ordering::Greater,
(None, Some(_)) => Ordering::Less,
(None, None) => Ordering::Equal,
};
if !ordering.is_eq() {
return ordering;
}
}
(Some(_), None) => return Ordering::Greater,
(None, Some(_)) => return Ordering::Less,
(None, None) => {
if !original_paths_equal {
return natural_sort(path_a.as_unix_str(), path_b.as_unix_str());
}
return Ordering::Equal;
}
}
}
}
pub fn compare_rel_paths_files_first(
(path_a, a_is_file): (&RelPath, bool),
(path_b, b_is_file): (&RelPath, bool),
) -> Ordering {
let original_paths_equal = std::ptr::eq(path_a, path_b) || path_a == path_b;
let mut components_a = path_a.components();
let mut components_b = path_b.components();
loop {
match (components_a.next(), components_b.next()) {
(Some(component_a), Some(component_b)) => {
let a_leaf_file = a_is_file && components_a.rest().is_empty();
let b_leaf_file = b_is_file && components_b.rest().is_empty();
let (a_stem, a_ext) = a_leaf_file
.then(|| stem_and_extension(component_a))
.unwrap_or_default();
let (b_stem, b_ext) = b_leaf_file
.then(|| stem_and_extension(component_b))
.unwrap_or_default();
let a_key = if a_leaf_file {
a_stem
} else {
Some(component_a)
};
let b_key = if b_leaf_file {
b_stem
} else {
Some(component_b)
};
let ordering = match (a_key, b_key) {
(Some(a), Some(b)) => {
if a_leaf_file && !b_leaf_file {
Ordering::Less
} else if !a_leaf_file && b_leaf_file {
Ordering::Greater
} else {
natural_sort_no_tiebreak(a, b).then_with(|| {
if a_leaf_file && b_leaf_file {
let a_ext_str = a_ext.unwrap_or_default().to_lowercase();
let b_ext_str = b_ext.unwrap_or_default().to_lowercase();
a_ext_str.cmp(&b_ext_str)
} else {
Ordering::Equal
}
})
}
}
(Some(_), None) => Ordering::Greater,
(None, Some(_)) => Ordering::Less,
(None, None) => Ordering::Equal,
};
if !ordering.is_eq() {
return ordering;
}
}
(Some(_), None) => return Ordering::Greater,
(None, Some(_)) => return Ordering::Less,
(None, None) => {
if !original_paths_equal {
return natural_sort(path_a.as_unix_str(), path_b.as_unix_str());
}
return Ordering::Equal;
}
}
}
}
pub fn compare_paths(
(path_a, a_is_file): (&Path, bool),
(path_b, b_is_file): (&Path, bool),
) -> Ordering {
let mut components_a = path_a.components().peekable();
let mut components_b = path_b.components().peekable();
loop {
match (components_a.next(), components_b.next()) {
(Some(component_a), Some(component_b)) => {
let a_is_file = components_a.peek().is_none() && a_is_file;
let b_is_file = components_b.peek().is_none() && b_is_file;
let ordering = a_is_file.cmp(&b_is_file).then_with(|| {
let path_a = Path::new(component_a.as_os_str());
let path_string_a = if a_is_file {
path_a.file_stem()
} else {
path_a.file_name()
}
.map(|s| s.to_string_lossy());
let path_b = Path::new(component_b.as_os_str());
let path_string_b = if b_is_file {
path_b.file_stem()
} else {
path_b.file_name()
}
.map(|s| s.to_string_lossy());
let compare_components = match (path_string_a, path_string_b) {
(Some(a), Some(b)) => natural_sort(&a, &b),
(Some(_), None) => Ordering::Greater,
(None, Some(_)) => Ordering::Less,
(None, None) => Ordering::Equal,
};
compare_components.then_with(|| {
if a_is_file && b_is_file {
let ext_a = path_a.extension().unwrap_or_default();
let ext_b = path_b.extension().unwrap_or_default();
ext_a.cmp(ext_b)
} else {
Ordering::Equal
}
})
});
if !ordering.is_eq() {
return ordering;
}
}
(Some(_), None) => break Ordering::Greater,
(None, Some(_)) => break Ordering::Less,
(None, None) => break Ordering::Equal,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WslPath {
pub distro: String,
pub path: std::ffi::OsString,
}
impl WslPath {
pub fn from_path<P: AsRef<Path>>(path: P) -> Option<WslPath> {
if cfg!(not(target_os = "windows")) {
return None;
}
use std::{
ffi::OsString,
path::{Component, Prefix},
};
let mut components = path.as_ref().components();
let Some(Component::Prefix(prefix)) = components.next() else {
return None;
};
let (server, distro) = match prefix.kind() {
Prefix::UNC(server, distro) => (server, distro),
Prefix::VerbatimUNC(server, distro) => (server, distro),
_ => return None,
};
let Some(Component::RootDir) = components.next() else {
return None;
};
let server_str = server.to_string_lossy();
if server_str == "wsl.localhost" || server_str == "wsl$" {
let mut result = OsString::from("");
for c in components {
use Component::*;
match c {
Prefix(p) => unreachable!("got {p:?}, but already stripped prefix"),
RootDir => unreachable!("got root dir, but already stripped root"),
CurDir => continue,
ParentDir => result.push("/.."),
Normal(s) => {
result.push("/");
result.push(s);
}
}
}
if result.is_empty() {
result.push("/");
}
Some(WslPath {
distro: distro.to_string_lossy().to_string(),
path: result,
})
} else {
None
}
}
}
#[cfg(test)]
mod tests {
use crate::rel_path::rel_path;
use super::*;
use util_macros::perf;
#[perf]
fn compare_paths_with_dots() {
let mut paths = vec![
(Path::new("test_dirs"), false),
(Path::new("test_dirs/1.46"), false),
(Path::new("test_dirs/1.46/bar_1"), true),
(Path::new("test_dirs/1.46/bar_2"), true),
(Path::new("test_dirs/1.45"), false),
(Path::new("test_dirs/1.45/foo_2"), true),
(Path::new("test_dirs/1.45/foo_1"), true),
];
paths.sort_by(|&a, &b| compare_paths(a, b));
assert_eq!(
paths,
vec![
(Path::new("test_dirs"), false),
(Path::new("test_dirs/1.45"), false),
(Path::new("test_dirs/1.45/foo_1"), true),
(Path::new("test_dirs/1.45/foo_2"), true),
(Path::new("test_dirs/1.46"), false),
(Path::new("test_dirs/1.46/bar_1"), true),
(Path::new("test_dirs/1.46/bar_2"), true),
]
);
let mut paths = vec![
(Path::new("root1/one.txt"), true),
(Path::new("root1/one.two.txt"), true),
];
paths.sort_by(|&a, &b| compare_paths(a, b));
assert_eq!(
paths,
vec![
(Path::new("root1/one.txt"), true),
(Path::new("root1/one.two.txt"), true),
]
);
}
#[perf]
fn compare_paths_with_same_name_different_extensions() {
let mut paths = vec![
(Path::new("test_dirs/file.rs"), true),
(Path::new("test_dirs/file.txt"), true),
(Path::new("test_dirs/file.md"), true),
(Path::new("test_dirs/file"), true),
(Path::new("test_dirs/file.a"), true),
];
paths.sort_by(|&a, &b| compare_paths(a, b));
assert_eq!(
paths,
vec![
(Path::new("test_dirs/file"), true),
(Path::new("test_dirs/file.a"), true),
(Path::new("test_dirs/file.md"), true),
(Path::new("test_dirs/file.rs"), true),
(Path::new("test_dirs/file.txt"), true),
]
);
}
#[perf]
fn compare_paths_case_semi_sensitive() {
let mut paths = vec![
(Path::new("test_DIRS"), false),
(Path::new("test_DIRS/foo_1"), true),
(Path::new("test_DIRS/foo_2"), true),
(Path::new("test_DIRS/bar"), true),
(Path::new("test_DIRS/BAR"), true),
(Path::new("test_dirs"), false),
(Path::new("test_dirs/foo_1"), true),
(Path::new("test_dirs/foo_2"), true),
(Path::new("test_dirs/bar"), true),
(Path::new("test_dirs/BAR"), true),
];
paths.sort_by(|&a, &b| compare_paths(a, b));
assert_eq!(
paths,
vec![
(Path::new("test_dirs"), false),
(Path::new("test_dirs/bar"), true),
(Path::new("test_dirs/BAR"), true),
(Path::new("test_dirs/foo_1"), true),
(Path::new("test_dirs/foo_2"), true),
(Path::new("test_DIRS"), false),
(Path::new("test_DIRS/bar"), true),
(Path::new("test_DIRS/BAR"), true),
(Path::new("test_DIRS/foo_1"), true),
(Path::new("test_DIRS/foo_2"), true),
]
);
}
#[perf]
fn compare_paths_mixed_case_numeric_ordering() {
let mut entries = [
(Path::new(".config"), false),
(Path::new("Dir1"), false),
(Path::new("dir01"), false),
(Path::new("dir2"), false),
(Path::new("Dir02"), false),
(Path::new("dir10"), false),
(Path::new("Dir10"), false),
];
entries.sort_by(|&a, &b| compare_paths(a, b));
let ordered: Vec<&str> = entries
.iter()
.map(|(path, _)| path.to_str().unwrap())
.collect();
assert_eq!(
ordered,
vec![
".config", "Dir1", "dir01", "dir2", "Dir02", "dir10", "Dir10"
]
);
}
#[perf]
fn compare_rel_paths_mixed_case_insensitive() {
let mut paths = vec![
(RelPath::unix("zebra.txt").unwrap(), true),
(RelPath::unix("Apple").unwrap(), false),
(RelPath::unix("banana.rs").unwrap(), true),
(RelPath::unix("Carrot").unwrap(), false),
(RelPath::unix("aardvark.txt").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("aardvark.txt").unwrap(), true),
(RelPath::unix("Apple").unwrap(), false),
(RelPath::unix("banana.rs").unwrap(), true),
(RelPath::unix("Carrot").unwrap(), false),
(RelPath::unix("zebra.txt").unwrap(), true),
]
);
}
#[perf]
fn compare_rel_paths_files_first_basic() {
let mut paths = vec![
(RelPath::unix("zebra.txt").unwrap(), true),
(RelPath::unix("Apple").unwrap(), false),
(RelPath::unix("banana.rs").unwrap(), true),
(RelPath::unix("Carrot").unwrap(), false),
(RelPath::unix("aardvark.txt").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_files_first(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("aardvark.txt").unwrap(), true),
(RelPath::unix("banana.rs").unwrap(), true),
(RelPath::unix("zebra.txt").unwrap(), true),
(RelPath::unix("Apple").unwrap(), false),
(RelPath::unix("Carrot").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_files_first_case_insensitive() {
let mut paths = vec![
(RelPath::unix("Zebra.txt").unwrap(), true),
(RelPath::unix("apple").unwrap(), false),
(RelPath::unix("Banana.rs").unwrap(), true),
(RelPath::unix("carrot").unwrap(), false),
(RelPath::unix("Aardvark.txt").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_files_first(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("Aardvark.txt").unwrap(), true),
(RelPath::unix("Banana.rs").unwrap(), true),
(RelPath::unix("Zebra.txt").unwrap(), true),
(RelPath::unix("apple").unwrap(), false),
(RelPath::unix("carrot").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_files_first_numeric() {
let mut paths = vec![
(RelPath::unix("file10.txt").unwrap(), true),
(RelPath::unix("dir2").unwrap(), false),
(RelPath::unix("file2.txt").unwrap(), true),
(RelPath::unix("dir10").unwrap(), false),
(RelPath::unix("file1.txt").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_files_first(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("file1.txt").unwrap(), true),
(RelPath::unix("file2.txt").unwrap(), true),
(RelPath::unix("file10.txt").unwrap(), true),
(RelPath::unix("dir2").unwrap(), false),
(RelPath::unix("dir10").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_mixed_case() {
let mut paths = vec![
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix("readme.txt").unwrap(), true),
(RelPath::unix("ReadMe.rs").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("readme.txt").unwrap(), true),
(RelPath::unix("ReadMe.rs").unwrap(), true),
(RelPath::unix("README.md").unwrap(), true),
]
);
}
#[perf]
fn compare_rel_paths_mixed_files_and_dirs() {
let mut paths = vec![
(RelPath::unix("file2.txt").unwrap(), true),
(RelPath::unix("Dir1").unwrap(), false),
(RelPath::unix("file1.txt").unwrap(), true),
(RelPath::unix("dir2").unwrap(), false),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("Dir1").unwrap(), false),
(RelPath::unix("dir2").unwrap(), false),
(RelPath::unix("file1.txt").unwrap(), true),
(RelPath::unix("file2.txt").unwrap(), true),
]
);
}
#[perf]
fn compare_rel_paths_mixed_with_nested_paths() {
let mut paths = vec![
(RelPath::unix("src/main.rs").unwrap(), true),
(RelPath::unix("Cargo.toml").unwrap(), true),
(RelPath::unix("src").unwrap(), false),
(RelPath::unix("target").unwrap(), false),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("Cargo.toml").unwrap(), true),
(RelPath::unix("src").unwrap(), false),
(RelPath::unix("src/main.rs").unwrap(), true),
(RelPath::unix("target").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_files_first_with_nested() {
let mut paths = vec![
(RelPath::unix("src/lib.rs").unwrap(), true),
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix("src").unwrap(), false),
(RelPath::unix("tests").unwrap(), false),
];
paths.sort_by(|&a, &b| compare_rel_paths_files_first(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix("src").unwrap(), false),
(RelPath::unix("src/lib.rs").unwrap(), true),
(RelPath::unix("tests").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_mixed_dotfiles() {
let mut paths = vec![
(RelPath::unix(".gitignore").unwrap(), true),
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix(".github").unwrap(), false),
(RelPath::unix("src").unwrap(), false),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix(".github").unwrap(), false),
(RelPath::unix(".gitignore").unwrap(), true),
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix("src").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_files_first_dotfiles() {
let mut paths = vec![
(RelPath::unix(".gitignore").unwrap(), true),
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix(".github").unwrap(), false),
(RelPath::unix("src").unwrap(), false),
];
paths.sort_by(|&a, &b| compare_rel_paths_files_first(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix(".gitignore").unwrap(), true),
(RelPath::unix("README.md").unwrap(), true),
(RelPath::unix(".github").unwrap(), false),
(RelPath::unix("src").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_mixed_same_stem_different_extension() {
let mut paths = vec![
(RelPath::unix("file.rs").unwrap(), true),
(RelPath::unix("file.md").unwrap(), true),
(RelPath::unix("file.txt").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("file.txt").unwrap(), true),
(RelPath::unix("file.rs").unwrap(), true),
(RelPath::unix("file.md").unwrap(), true),
]
);
}
#[perf]
fn compare_rel_paths_files_first_same_stem() {
let mut paths = vec![
(RelPath::unix("main.rs").unwrap(), true),
(RelPath::unix("main.c").unwrap(), true),
(RelPath::unix("main").unwrap(), false),
];
paths.sort_by(|&a, &b| compare_rel_paths_files_first(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("main.c").unwrap(), true),
(RelPath::unix("main.rs").unwrap(), true),
(RelPath::unix("main").unwrap(), false),
]
);
}
#[perf]
fn compare_rel_paths_mixed_deep_nesting() {
let mut paths = vec![
(RelPath::unix("a/b/c.txt").unwrap(), true),
(RelPath::unix("A/B.txt").unwrap(), true),
(RelPath::unix("a.txt").unwrap(), true),
(RelPath::unix("A.txt").unwrap(), true),
];
paths.sort_by(|&a, &b| compare_rel_paths_mixed(a, b));
assert_eq!(
paths,
vec![
(RelPath::unix("A/B.txt").unwrap(), true),
(RelPath::unix("a/b/c.txt").unwrap(), true),
(RelPath::unix("a.txt").unwrap(), true),
(RelPath::unix("A.txt").unwrap(), true),
]
);
}
#[perf]
fn path_with_position_parse_posix_path() {
assert_eq!(
PathWithPosition::parse_str("test_file"),
PathWithPosition {
path: PathBuf::from("test_file"),
row: None,
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("a:bc:.zip:1"),
PathWithPosition {
path: PathBuf::from("a:bc:.zip"),
row: Some(1),
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("one.second.zip:1"),
PathWithPosition {
path: PathBuf::from("one.second.zip"),
row: Some(1),
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("test_file:10:1:"),
PathWithPosition {
path: PathBuf::from("test_file"),
row: Some(10),
column: Some(1)
}
);
assert_eq!(
PathWithPosition::parse_str("test_file.rs:"),
PathWithPosition {
path: PathBuf::from("test_file.rs"),
row: None,
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("test_file.rs:1:"),
PathWithPosition {
path: PathBuf::from("test_file.rs"),
row: Some(1),
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("ab\ncd"),
PathWithPosition {
path: PathBuf::from("ab\ncd"),
row: None,
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("👋\nab"),
PathWithPosition {
path: PathBuf::from("👋\nab"),
row: None,
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("Types.hs:(617,9)-(670,28):"),
PathWithPosition {
path: PathBuf::from("Types.hs"),
row: Some(617),
column: Some(9),
}
);
}
#[perf]
#[cfg(not(target_os = "windows"))]
fn path_with_position_parse_posix_path_with_suffix() {
assert_eq!(
PathWithPosition::parse_str("foo/bar:34:in"),
PathWithPosition {
path: PathBuf::from("foo/bar"),
row: Some(34),
column: None,
}
);
assert_eq!(
PathWithPosition::parse_str("foo/bar.rs:1902:::15:"),
PathWithPosition {
path: PathBuf::from("foo/bar.rs:1902"),
row: Some(15),
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("app-editors:zed-0.143.6:20240710-201212.log:34:"),
PathWithPosition {
path: PathBuf::from("app-editors:zed-0.143.6:20240710-201212.log"),
row: Some(34),
column: None,
}
);
assert_eq!(
PathWithPosition::parse_str("crates/file_finder/src/file_finder.rs:1902:13:"),
PathWithPosition {
path: PathBuf::from("crates/file_finder/src/file_finder.rs"),
row: Some(1902),
column: Some(13),
}
);
assert_eq!(
PathWithPosition::parse_str("crate/utils/src/test:today.log:34"),
PathWithPosition {
path: PathBuf::from("crate/utils/src/test:today.log"),
row: Some(34),
column: None,
}
);
assert_eq!(
PathWithPosition::parse_str("/testing/out/src/file_finder.odin(7:15)"),
PathWithPosition {
path: PathBuf::from("/testing/out/src/file_finder.odin"),
row: Some(7),
column: Some(15),
}
);
}
#[perf]
#[cfg(target_os = "windows")]
fn path_with_position_parse_windows_path() {
assert_eq!(
PathWithPosition::parse_str("crates\\utils\\paths.rs"),
PathWithPosition {
path: PathBuf::from("crates\\utils\\paths.rs"),
row: None,
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("C:\\Users\\someone\\test_file.rs"),
PathWithPosition {
path: PathBuf::from("C:\\Users\\someone\\test_file.rs"),
row: None,
column: None
}
);
}
#[perf]
#[cfg(target_os = "windows")]
fn path_with_position_parse_windows_path_with_suffix() {
assert_eq!(
PathWithPosition::parse_str("crates\\utils\\paths.rs:101"),
PathWithPosition {
path: PathBuf::from("crates\\utils\\paths.rs"),
row: Some(101),
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("\\\\?\\C:\\Users\\someone\\test_file.rs:1:20"),
PathWithPosition {
path: PathBuf::from("\\\\?\\C:\\Users\\someone\\test_file.rs"),
row: Some(1),
column: Some(20)
}
);
assert_eq!(
PathWithPosition::parse_str("C:\\Users\\someone\\test_file.rs(1902,13)"),
PathWithPosition {
path: PathBuf::from("C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: Some(13)
}
);
assert_eq!(
PathWithPosition::parse_str("\\\\?\\C:\\Users\\someone\\test_file.rs:1902:13:"),
PathWithPosition {
path: PathBuf::from("\\\\?\\C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: Some(13)
}
);
assert_eq!(
PathWithPosition::parse_str("\\\\?\\C:\\Users\\someone\\test_file.rs:1902:13:15:"),
PathWithPosition {
path: PathBuf::from("\\\\?\\C:\\Users\\someone\\test_file.rs:1902"),
row: Some(13),
column: Some(15)
}
);
assert_eq!(
PathWithPosition::parse_str("\\\\?\\C:\\Users\\someone\\test_file.rs:1902:::15:"),
PathWithPosition {
path: PathBuf::from("\\\\?\\C:\\Users\\someone\\test_file.rs:1902"),
row: Some(15),
column: None
}
);
assert_eq!(
PathWithPosition::parse_str("\\\\?\\C:\\Users\\someone\\test_file.rs(1902,13):"),
PathWithPosition {
path: PathBuf::from("\\\\?\\C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: Some(13),
}
);
assert_eq!(
PathWithPosition::parse_str("\\\\?\\C:\\Users\\someone\\test_file.rs(1902):"),
PathWithPosition {
path: PathBuf::from("\\\\?\\C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: None,
}
);
assert_eq!(
PathWithPosition::parse_str("C:\\Users\\someone\\test_file.rs:1902:13:"),
PathWithPosition {
path: PathBuf::from("C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: Some(13),
}
);
assert_eq!(
PathWithPosition::parse_str("C:\\Users\\someone\\test_file.rs(1902,13):"),
PathWithPosition {
path: PathBuf::from("C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: Some(13),
}
);
assert_eq!(
PathWithPosition::parse_str("C:\\Users\\someone\\test_file.rs(1902):"),
PathWithPosition {
path: PathBuf::from("C:\\Users\\someone\\test_file.rs"),
row: Some(1902),
column: None,
}
);
assert_eq!(
PathWithPosition::parse_str("crates/utils/paths.rs:101"),
PathWithPosition {
path: PathBuf::from("crates\\utils\\paths.rs"),
row: Some(101),
column: None,
}
);
}
#[perf]
fn test_path_compact() {
let path: PathBuf = [
home_dir().to_string_lossy().into_owned(),
"some_file.txt".to_string(),
]
.iter()
.collect();
if cfg!(any(target_os = "linux", target_os = "freebsd")) || cfg!(target_os = "macos") {
assert_eq!(path.compact().to_str(), Some("~/some_file.txt"));
} else {
assert_eq!(path.compact().to_str(), path.to_str());
}
}
#[perf]
fn test_extension_or_hidden_file_name() {
let path = Path::new("/a/b/c/file_name.rs");
assert_eq!(path.extension_or_hidden_file_name(), Some("rs"));
let path = Path::new("/a/b/c/file.name.rs");
assert_eq!(path.extension_or_hidden_file_name(), Some("rs"));
let path = Path::new("/a/b/c/long.file.name.rs");
assert_eq!(path.extension_or_hidden_file_name(), Some("rs"));
let path = Path::new("/a/b/c/.gitignore");
assert_eq!(path.extension_or_hidden_file_name(), Some("gitignore"));
let path = Path::new("/a/b/c/.eslintrc.js");
assert_eq!(path.extension_or_hidden_file_name(), Some("eslintrc.js"));
}
#[perf]
#[perf]
#[cfg(target_os = "windows")]
fn test_sanitized_path() {
let path = Path::new("C:\\Users\\someone\\test_file.rs");
let sanitized_path = SanitizedPath::new(path);
assert_eq!(
sanitized_path.to_string(),
"C:\\Users\\someone\\test_file.rs"
);
let path = Path::new("\\\\?\\C:\\Users\\someone\\test_file.rs");
let sanitized_path = SanitizedPath::new(path);
assert_eq!(
sanitized_path.to_string(),
"C:\\Users\\someone\\test_file.rs"
);
}
#[perf]
fn test_compare_numeric_segments() {
fn compare(a: &str, b: &str) -> Ordering {
let mut a_iter = a.chars().peekable();
let mut b_iter = b.chars().peekable();
let result = compare_numeric_segments(&mut a_iter, &mut b_iter);
assert!(
!a_iter.next().is_some_and(|c| c.is_ascii_digit()),
"Iterator a should have consumed all digits"
);
assert!(
!b_iter.next().is_some_and(|c| c.is_ascii_digit()),
"Iterator b should have consumed all digits"
);
result
}
assert_eq!(compare("0", "0"), Ordering::Equal);
assert_eq!(compare("1", "2"), Ordering::Less);
assert_eq!(compare("9", "10"), Ordering::Less);
assert_eq!(compare("10", "9"), Ordering::Greater);
assert_eq!(compare("99", "100"), Ordering::Less);
assert_eq!(compare("0", "00"), Ordering::Less);
assert_eq!(compare("00", "0"), Ordering::Greater);
assert_eq!(compare("01", "1"), Ordering::Greater);
assert_eq!(compare("001", "1"), Ordering::Greater);
assert_eq!(compare("001", "01"), Ordering::Greater);
assert_eq!(compare("000100", "100"), Ordering::Greater);
assert_eq!(compare("100", "0100"), Ordering::Less);
assert_eq!(compare("0100", "00100"), Ordering::Less);
assert_eq!(compare("9999999999", "10000000000"), Ordering::Less);
assert_eq!(
compare(
"340282366920938463463374607431768211455", "340282366920938463463374607431768211456"
),
Ordering::Less
);
assert_eq!(
compare(
"340282366920938463463374607431768211456", "340282366920938463463374607431768211455"
),
Ordering::Greater
);
let mut a_iter = "123abc".chars().peekable();
let mut b_iter = "456def".chars().peekable();
compare_numeric_segments(&mut a_iter, &mut b_iter);
assert_eq!(a_iter.collect::<String>(), "abc");
assert_eq!(b_iter.collect::<String>(), "def");
}
#[perf]
fn test_natural_sort() {
assert_eq!(natural_sort("a", "b"), Ordering::Less);
assert_eq!(natural_sort("b", "a"), Ordering::Greater);
assert_eq!(natural_sort("a", "a"), Ordering::Equal);
assert_eq!(natural_sort("a", "A"), Ordering::Less);
assert_eq!(natural_sort("A", "a"), Ordering::Greater);
assert_eq!(natural_sort("aA", "aa"), Ordering::Greater);
assert_eq!(natural_sort("aa", "aA"), Ordering::Less);
assert_eq!(natural_sort("1", "2"), Ordering::Less);
assert_eq!(natural_sort("2", "10"), Ordering::Less);
assert_eq!(natural_sort("02", "10"), Ordering::Less);
assert_eq!(natural_sort("02", "2"), Ordering::Greater);
assert_eq!(natural_sort("a1", "a2"), Ordering::Less);
assert_eq!(natural_sort("a2", "a10"), Ordering::Less);
assert_eq!(natural_sort("a02", "a2"), Ordering::Greater);
assert_eq!(natural_sort("a1b", "a1c"), Ordering::Less);
assert_eq!(natural_sort("1a2", "1a10"), Ordering::Less);
assert_eq!(natural_sort("1a10", "1a2"), Ordering::Greater);
assert_eq!(natural_sort("2a1", "10a1"), Ordering::Less);
assert_eq!(natural_sort("a-1", "a-2"), Ordering::Less);
assert_eq!(natural_sort("a_1", "a_2"), Ordering::Less);
assert_eq!(natural_sort("a.1", "a.2"), Ordering::Less);
assert_eq!(natural_sort("æ–‡1", "æ–‡2"), Ordering::Less);
assert_eq!(natural_sort("æ–‡2", "æ–‡10"), Ordering::Less);
assert_eq!(natural_sort("🔤1", "🔤2"), Ordering::Less);
assert_eq!(natural_sort("", ""), Ordering::Equal);
assert_eq!(natural_sort("", "a"), Ordering::Less);
assert_eq!(natural_sort("a", ""), Ordering::Greater);
assert_eq!(natural_sort(" ", " "), Ordering::Less);
assert_eq!(natural_sort("File-1.txt", "File-2.txt"), Ordering::Less);
assert_eq!(natural_sort("File-02.txt", "File-2.txt"), Ordering::Greater);
assert_eq!(natural_sort("File-2.txt", "File-10.txt"), Ordering::Less);
assert_eq!(natural_sort("File_A1", "File_A2"), Ordering::Less);
assert_eq!(natural_sort("File_a1", "File_A1"), Ordering::Less);
}
#[perf]
fn test_compare_paths() {
fn compare(a: &str, is_a_file: bool, b: &str, is_b_file: bool) -> Ordering {
compare_paths((Path::new(a), is_a_file), (Path::new(b), is_b_file))
}
assert_eq!(compare("a", true, "b", true), Ordering::Less);
assert_eq!(compare("b", true, "a", true), Ordering::Greater);
assert_eq!(compare("a", true, "a", true), Ordering::Equal);
assert_eq!(compare("a", true, "a", false), Ordering::Greater);
assert_eq!(compare("a", false, "a", true), Ordering::Less);
assert_eq!(compare("b", false, "a", true), Ordering::Less);
assert_eq!(compare("a.txt", true, "a.md", true), Ordering::Greater);
assert_eq!(compare("a.md", true, "a.txt", true), Ordering::Less);
assert_eq!(compare("a", true, "a.txt", true), Ordering::Less);
assert_eq!(compare("dir/a", true, "dir/b", true), Ordering::Less);
assert_eq!(compare("dir1/a", true, "dir2/a", true), Ordering::Less);
assert_eq!(compare("dir/sub/a", true, "dir/a", true), Ordering::Less);
assert_eq!(
compare("Dir/file", true, "dir/file", true),
Ordering::Greater
);
assert_eq!(
compare("dir/File", true, "dir/file", true),
Ordering::Greater
);
assert_eq!(compare("dir/file", true, "Dir/File", true), Ordering::Less);
assert_eq!(compare(".hidden", true, "visible", true), Ordering::Less);
assert_eq!(compare("_special", true, "normal", true), Ordering::Less);
assert_eq!(compare(".config", false, ".data", false), Ordering::Less);
assert_eq!(
compare("dir1/file", true, "dir2/file", true),
Ordering::Less
);
assert_eq!(
compare("dir2/file", true, "dir10/file", true),
Ordering::Less
);
assert_eq!(
compare("dir02/file", true, "dir2/file", true),
Ordering::Greater
);
assert_eq!(compare("/a", true, "/b", true), Ordering::Less);
assert_eq!(compare("/", false, "/a", true), Ordering::Less);
assert_eq!(
compare("project/src/main.rs", true, "project/src/lib.rs", true),
Ordering::Greater
);
assert_eq!(
compare(
"project/tests/test_1.rs",
true,
"project/tests/test_2.rs",
true
),
Ordering::Less
);
assert_eq!(
compare(
"project/v1.0.0/README.md",
true,
"project/v1.10.0/README.md",
true
),
Ordering::Less
);
}
#[perf]
fn test_natural_sort_case_sensitivity() {
std::thread::sleep(std::time::Duration::from_millis(100));
assert_eq!(natural_sort("a", "A"), Ordering::Less);
assert_eq!(natural_sort("A", "a"), Ordering::Greater);
assert_eq!(natural_sort("a", "a"), Ordering::Equal);
assert_eq!(natural_sort("A", "A"), Ordering::Equal);
assert_eq!(natural_sort("aaa", "AAA"), Ordering::Less);
assert_eq!(natural_sort("AAA", "aaa"), Ordering::Greater);
assert_eq!(natural_sort("aAa", "AaA"), Ordering::Less);
assert_eq!(natural_sort("a", "b"), Ordering::Less);
assert_eq!(natural_sort("A", "b"), Ordering::Less);
assert_eq!(natural_sort("a", "B"), Ordering::Less);
}
#[perf]
fn test_natural_sort_with_numbers() {
assert_eq!(natural_sort("file1", "file2"), Ordering::Less);
assert_eq!(natural_sort("file2", "file10"), Ordering::Less);
assert_eq!(natural_sort("file10", "file2"), Ordering::Greater);
assert_eq!(natural_sort("1file", "2file"), Ordering::Less);
assert_eq!(natural_sort("file1text", "file2text"), Ordering::Less);
assert_eq!(natural_sort("text1file", "text2file"), Ordering::Less);
assert_eq!(natural_sort("file1-2", "file1-10"), Ordering::Less);
assert_eq!(natural_sort("2-1file", "10-1file"), Ordering::Less);
assert_eq!(natural_sort("file002", "file2"), Ordering::Greater);
assert_eq!(natural_sort("file002", "file10"), Ordering::Less);
assert_eq!(
natural_sort("file999999999999999999999", "file999999999999999999998"),
Ordering::Greater
);
assert_eq!(
natural_sort(
"file340282366920938463463374607431768211454",
"file340282366920938463463374607431768211455"
),
Ordering::Less
);
assert_eq!(
natural_sort(
"file340282366920938463463374607431768211456",
"file340282366920938463463374607431768211455"
),
Ordering::Greater
);
assert_eq!(
natural_sort(
"file3402823669209384634633746074317682114560",
"file340282366920938463463374607431768211455"
),
Ordering::Greater
);
assert_eq!(
natural_sort(
"file0340282366920938463463374607431768211455",
"file340282366920938463463374607431768211455"
),
Ordering::Greater
);
assert_eq!(
natural_sort(
"file999999999999999999999999999999999999999999999999",
"file9999999999999999999999999999999999999999999999999"
),
Ordering::Less
);
}
#[perf]
fn test_natural_sort_case_sensitive() {
assert_eq!(natural_sort("File1", "file2"), Ordering::Less);
assert_eq!(natural_sort("file1", "File2"), Ordering::Less);
assert_eq!(natural_sort("Dir1", "dir01"), Ordering::Less);
assert_eq!(natural_sort("dir2", "Dir02"), Ordering::Less);
assert_eq!(natural_sort("dir2", "dir02"), Ordering::Less);
assert_eq!(natural_sort("dir1", "Dir1"), Ordering::Less);
assert_eq!(natural_sort("dir02", "Dir02"), Ordering::Less);
assert_eq!(natural_sort("dir10", "Dir10"), Ordering::Less);
}
#[perf]
fn test_natural_sort_edge_cases() {
assert_eq!(natural_sort("", ""), Ordering::Equal);
assert_eq!(natural_sort("", "a"), Ordering::Less);
assert_eq!(natural_sort("a", ""), Ordering::Greater);
assert_eq!(natural_sort("file-1", "file_1"), Ordering::Less);
assert_eq!(natural_sort("file.1", "file_1"), Ordering::Less);
assert_eq!(natural_sort("file 1", "file_1"), Ordering::Less);
assert_eq!(natural_sort("fileâ‘ ", "fileâ‘¡"), Ordering::Less);
assert_eq!(natural_sort("fileâ‘©", "fileâ‘¡"), Ordering::Greater);
assert_eq!(natural_sort("fileæ¼¢", "fileå—"), Ordering::Greater);
assert_eq!(natural_sort("file-1a", "file-1b"), Ordering::Less);
assert_eq!(natural_sort("file-1.2", "file-1.10"), Ordering::Less);
assert_eq!(natural_sort("file-1.10", "file-1.2"), Ordering::Greater);
}
#[test]
fn test_multiple_extensions() {
let path = Path::new("/a/b/c/file_name");
assert_eq!(path.multiple_extensions(), None);
let path = Path::new("/a/b/c/file_name.tsx");
assert_eq!(path.multiple_extensions(), None);
let path = Path::new("/a/b/c/file_name.stories.tsx");
assert_eq!(path.multiple_extensions(), Some("stories.tsx".to_string()));
let path = Path::new("/a/b/c/long.app.tar.gz");
assert_eq!(path.multiple_extensions(), Some("app.tar.gz".to_string()));
}
#[test]
fn test_strip_path_suffix() {
let base = Path::new("/a/b/c/file_name");
let suffix = Path::new("file_name");
assert_eq!(strip_path_suffix(base, suffix), Some(Path::new("/a/b/c")));
let base = Path::new("/a/b/c/file_name.tsx");
let suffix = Path::new("file_name.tsx");
assert_eq!(strip_path_suffix(base, suffix), Some(Path::new("/a/b/c")));
let base = Path::new("/a/b/c/file_name.stories.tsx");
let suffix = Path::new("c/file_name.stories.tsx");
assert_eq!(strip_path_suffix(base, suffix), Some(Path::new("/a/b")));
let base = Path::new("/a/b/c/long.app.tar.gz");
let suffix = Path::new("b/c/long.app.tar.gz");
assert_eq!(strip_path_suffix(base, suffix), Some(Path::new("/a")));
let base = Path::new("/a/b/c/long.app.tar.gz");
let suffix = Path::new("/a/b/c/long.app.tar.gz");
assert_eq!(strip_path_suffix(base, suffix), Some(Path::new("")));
let base = Path::new("/a/b/c/long.app.tar.gz");
let suffix = Path::new("/a/b/c/no_match.app.tar.gz");
assert_eq!(strip_path_suffix(base, suffix), None);
let base = Path::new("/a/b/c/long.app.tar.gz");
let suffix = Path::new("app.tar.gz");
assert_eq!(strip_path_suffix(base, suffix), None);
}
#[test]
fn test_strip_prefix() {
let expected = [
(
PathStyle::Posix,
"/a/b/c",
"/a/b",
Some(rel_path("c").into_arc()),
),
(
PathStyle::Posix,
"/a/b/c",
"/a/b/",
Some(rel_path("c").into_arc()),
),
(
PathStyle::Posix,
"/a/b/c",
"/",
Some(rel_path("a/b/c").into_arc()),
),
(PathStyle::Posix, "/a/b/c", "", None),
(PathStyle::Posix, "/a/b//c", "/a/b/", None),
(PathStyle::Posix, "/a/bc", "/a/b", None),
(
PathStyle::Posix,
"/a/b/c",
"/a/b/c",
Some(rel_path("").into_arc()),
),
(
PathStyle::Windows,
"C:\\a\\b\\c",
"C:\\a\\b",
Some(rel_path("c").into_arc()),
),
(
PathStyle::Windows,
"C:\\a\\b\\c",
"C:\\a\\b\\",
Some(rel_path("c").into_arc()),
),
(
PathStyle::Windows,
"C:\\a\\b\\c",
"C:\\",
Some(rel_path("a/b/c").into_arc()),
),
(PathStyle::Windows, "C:\\a\\b\\c", "", None),
(PathStyle::Windows, "C:\\a\\b\\\\c", "C:\\a\\b\\", None),
(PathStyle::Windows, "C:\\a\\bc", "C:\\a\\b", None),
(
PathStyle::Windows,
"C:\\a\\b/c",
"C:\\a\\b",
Some(rel_path("c").into_arc()),
),
(
PathStyle::Windows,
"C:\\a\\b/c",
"C:\\a\\b\\",
Some(rel_path("c").into_arc()),
),
(
PathStyle::Windows,
"C:\\a\\b/c",
"C:\\a\\b/",
Some(rel_path("c").into_arc()),
),
];
let actual = expected.clone().map(|(style, child, parent, _)| {
(
style,
child,
parent,
style
.strip_prefix(child.as_ref(), parent.as_ref())
.map(|rel_path| rel_path.into_arc()),
)
});
pretty_assertions::assert_eq!(actual, expected);
}
#[cfg(target_os = "windows")]
#[test]
fn test_wsl_path() {
use super::WslPath;
let path = "/a/b/c";
assert_eq!(WslPath::from_path(&path), None);
let path = r"\\wsl.localhost";
assert_eq!(WslPath::from_path(&path), None);
let path = r"\\wsl.localhost\Distro";
assert_eq!(
WslPath::from_path(&path),
Some(WslPath {
distro: "Distro".to_owned(),
path: "/".into(),
})
);
let path = r"\\wsl.localhost\Distro\blue";
assert_eq!(
WslPath::from_path(&path),
Some(WslPath {
distro: "Distro".to_owned(),
path: "/blue".into()
})
);
let path = r"\\wsl$\archlinux\tomato\.\paprika\..\aubergine.txt";
assert_eq!(
WslPath::from_path(&path),
Some(WslPath {
distro: "archlinux".to_owned(),
path: "/tomato/paprika/../aubergine.txt".into()
})
);
let path = r"\\windows.localhost\Distro\foo";
assert_eq!(WslPath::from_path(&path), None);
}
}