604 lines · 20.9 KB · Rust
RawDownload
use std::sync::OnceLock;use std::{    ffi::OsStr,    path::{Path, PathBuf},}; use globset::{Glob, GlobSet, GlobSetBuilder};use serde::{Deserialize, Serialize}; /// Returns the path to the user's home directory.pub fn home_dir() -> &'static PathBuf {    static HOME_DIR: OnceLock<PathBuf> = OnceLock::new();    HOME_DIR.get_or_init(|| dirs::home_dir().expect("failed to determine home directory"))} pub trait PathExt {    fn compact(&self) -> PathBuf;    fn icon_stem_or_suffix(&self) -> Option<&str>;    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 anyhow::anyhow;            use tendril::fmt::{Format, WTF8};            WTF8::validate(bytes)                .then(|| {                    // Safety: bytes are valid WTF-8 sequence.                    Self::from(Path::new(unsafe {                        OsStr::from_encoded_bytes_unchecked(bytes)                    }))                })                .ok_or_else(|| anyhow!("Invalid WTF-8 sequence: {bytes:?}"))        }    }} impl<T: AsRef<Path>> PathExt for T {    /// Compacts a given file path by replacing the user's home directory    /// prefix with a tilde (`~`).    ///    /// # Returns    ///    /// * A `PathBuf` containing the compacted file path. If the input path    ///   does not have the user's home directory prefix, or if we are not on    ///   Linux or macOS, the original path is returned unchanged.    fn compact(&self) -> PathBuf {        if cfg!(target_os = "linux") || 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()        }    }     /// Returns either the suffix if available, or the file stem otherwise to determine which file icon to use    fn icon_stem_or_suffix(&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())    }     /// Returns a file's extension or, if the file is hidden, its name without the leading dot    fn extension_or_hidden_file_name(&self) -> Option<&str> {        if let Some(extension) = self.as_ref().extension() {            return extension.to_str();        }         self.as_ref().file_name()?.to_str()?.split('.').last()    }} /// A delimiter to use in `path_query:row_number:column_number` strings parsing.pub const FILE_ROW_COLUMN_DELIMITER: char = ':'; /// A representation of a path-like string with optional row and column numbers./// Matching values example: `te`, `test.rs:22`, `te:22:5`, etc.#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]pub struct PathLikeWithPosition<P> {    pub path_like: P,    pub row: Option<u32>,    // Absent if row is absent.    pub column: Option<u32>,} impl<P> PathLikeWithPosition<P> {    /// Parses a string that possibly has `:row:column` suffix.    /// Ignores trailing `:`s, so `test.rs:22:` is parsed as `test.rs:22`.    /// If any of the row/column component parsing fails, the whole string is then parsed as a path like.    /// If on Windows, `s` will replace `/` with `\` for compatibility.    pub fn parse_str<E>(        s: &str,        parse_path_like_str: impl Fn(&str, &str) -> Result<P, E>,    ) -> Result<Self, E> {        #[cfg(target_os = "windows")]        let s = &s.replace('/', "\\");         let fallback = |fallback_str| {            Ok(Self {                path_like: parse_path_like_str(s, fallback_str)?,                row: None,                column: None,            })        };         let trimmed = s.trim();         #[cfg(target_os = "windows")]        {            let is_absolute = trimmed.starts_with(r"\\?\");            if is_absolute {                return Self::parse_absolute_path(trimmed, |p| parse_path_like_str(s, p));            }        }         match trimmed.split_once(FILE_ROW_COLUMN_DELIMITER) {            Some((path_like_str, maybe_row_and_col_str)) => {                let path_like_str = path_like_str.trim();                let maybe_row_and_col_str = maybe_row_and_col_str.trim();                if path_like_str.is_empty() {                    fallback(s)                } else if maybe_row_and_col_str.is_empty() {                    fallback(path_like_str)                } else {                    let (row_parse_result, maybe_col_str) =                        match maybe_row_and_col_str.split_once(FILE_ROW_COLUMN_DELIMITER) {                            Some((maybe_row_str, maybe_col_str)) => {                                (maybe_row_str.parse::<u32>(), maybe_col_str.trim())                            }                            None => (maybe_row_and_col_str.parse::<u32>(), ""),                        };                     match row_parse_result {                        Ok(row) => {                            if maybe_col_str.is_empty() {                                Ok(Self {                                    path_like: parse_path_like_str(s, path_like_str)?,                                    row: Some(row),                                    column: None,                                })                            } else {                                let (maybe_col_str, _) =                                    maybe_col_str.split_once(':').unwrap_or((maybe_col_str, ""));                                match maybe_col_str.parse::<u32>() {                                    Ok(col) => Ok(Self {                                        path_like: parse_path_like_str(s, path_like_str)?,                                        row: Some(row),                                        column: Some(col),                                    }),                                    Err(_) => Ok(Self {                                        path_like: parse_path_like_str(s, path_like_str)?,                                        row: Some(row),                                        column: None,                                    }),                                }                            }                        }                        Err(_) => Ok(Self {                            path_like: parse_path_like_str(s, path_like_str)?,                            row: None,                            column: None,                        }),                    }                }            }            None => fallback(s),        }    }     /// This helper function is used for parsing absolute paths on Windows. It exists because absolute paths on Windows are quite different from other platforms. See [this page](https://learn.microsoft.com/en-us/dotnet/standard/io/file-path-formats#dos-device-paths) for more information.    #[cfg(target_os = "windows")]    fn parse_absolute_path<E>(        s: &str,        parse_path_like_str: impl Fn(&str) -> Result<P, E>,    ) -> Result<Self, E> {        let fallback = |fallback_str| {            Ok(Self {                path_like: parse_path_like_str(fallback_str)?,                row: None,                column: None,            })        };         let mut iterator = s.split(FILE_ROW_COLUMN_DELIMITER);         let drive_prefix = iterator.next().unwrap_or_default();        let file_path = iterator.next().unwrap_or_default();         // TODO: How to handle drives without a letter? UNC paths?        let complete_path = drive_prefix.replace("\\\\?\\", "") + ":" + &file_path;         if let Some(row_str) = iterator.next() {            if let Some(column_str) = iterator.next() {                match row_str.parse::<u32>() {                    Ok(row) => match column_str.parse::<u32>() {                        Ok(col) => {                            return Ok(Self {                                path_like: parse_path_like_str(&complete_path)?,                                row: Some(row),                                column: Some(col),                            });                        }                         Err(_) => {                            return Ok(Self {                                path_like: parse_path_like_str(&complete_path)?,                                row: Some(row),                                column: None,                            });                        }                    },                     Err(_) => {                        return fallback(&complete_path);                    }                }            }        }        return fallback(&complete_path);    }     pub fn map_path_like<P2, E>(        self,        mapping: impl FnOnce(P) -> Result<P2, E>,    ) -> Result<PathLikeWithPosition<P2>, E> {        Ok(PathLikeWithPosition {            path_like: mapping(self.path_like)?,            row: self.row,            column: self.column,        })    }     pub fn to_string(&self, path_like_to_string: impl Fn(&P) -> String) -> String {        let path_like_string = path_like_to_string(&self.path_like);        if let Some(row) = self.row {            if let Some(column) = self.column {                format!("{path_like_string}:{row}:{column}")            } else {                format!("{path_like_string}:{row}")            }        } else {            path_like_string        }    }} #[derive(Clone, Debug, Default)]pub struct PathMatcher {    sources: Vec<String>,    glob: GlobSet,} // impl std::fmt::Display for PathMatcher {//     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {//         self.sources.fmt(f)//     }// } 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: &[String]) -> Result<Self, globset::Error> {        let globs = globs            .into_iter()            .map(|glob| Glob::new(&glob))            .collect::<Result<Vec<_>, _>>()?;        let sources = globs.iter().map(|glob| glob.glob().to_owned()).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 })    }     pub fn sources(&self) -> &[String] {        &self.sources    }     pub fn is_match<P: AsRef<Path>>(&self, other: P) -> bool {        let other_path = other.as_ref();        self.sources.iter().any(|source| {            let as_bytes = other_path.as_os_str().as_encoded_bytes();            as_bytes.starts_with(source.as_bytes()) || as_bytes.ends_with(source.as_bytes())        }) || self.glob.is_match(other_path)            || self.check_with_end_separator(other_path)    }     fn check_with_end_separator(&self, path: &Path) -> bool {        let path_str = path.to_string_lossy();        let separator = std::path::MAIN_SEPARATOR_STR;        if path_str.ends_with(separator) {            self.glob.is_match(path)        } else {            self.glob.is_match(path_str.to_string() + separator)        }    }} #[cfg(test)]mod tests {    use super::*;     type TestPath = PathLikeWithPosition<(String, String)>;     fn parse_str(s: &str) -> TestPath {        TestPath::parse_str(s, |normalized, s| {            Ok::<_, std::convert::Infallible>((normalized.to_string(), s.to_string()))        })        .expect("infallible")    }     #[test]    fn path_with_position_parsing_positive() {        let input_and_expected = [            (                "test_file.rs",                PathLikeWithPosition {                    path_like: ("test_file.rs".to_string(), "test_file.rs".to_string()),                    row: None,                    column: None,                },            ),            (                "test_file.rs:1",                PathLikeWithPosition {                    path_like: ("test_file.rs:1".to_string(), "test_file.rs".to_string()),                    row: Some(1),                    column: None,                },            ),            (                "test_file.rs:1:2",                PathLikeWithPosition {                    path_like: ("test_file.rs:1:2".to_string(), "test_file.rs".to_string()),                    row: Some(1),                    column: Some(2),                },            ),        ];         for (input, expected) in input_and_expected {            let actual = parse_str(input);            assert_eq!(                actual, expected,                "For positive case input str '{input}', got a parse mismatch"            );        }    }     #[test]    fn path_with_position_parsing_negative() {        for (input, row, column) in [            ("test_file.rs:a", None, None),            ("test_file.rs:a:b", None, None),            ("test_file.rs::", None, None),            ("test_file.rs::1", None, None),            ("test_file.rs:1::", Some(1), None),            ("test_file.rs::1:2", None, None),            ("test_file.rs:1::2", Some(1), None),            ("test_file.rs:1:2:3", Some(1), Some(2)),        ] {            let actual = parse_str(input);            assert_eq!(                actual,                PathLikeWithPosition {                    path_like: (input.to_string(), "test_file.rs".to_string()),                    row,                    column,                },                "For negative case input str '{input}', got a parse mismatch"            );        }    }     // Trim off trailing `:`s for otherwise valid input.    #[test]    fn path_with_position_parsing_special() {        #[cfg(not(target_os = "windows"))]        let input_and_expected = [            (                "test_file.rs:",                PathLikeWithPosition {                    path_like: ("test_file.rs:".to_string(), "test_file.rs".to_string()),                    row: None,                    column: None,                },            ),            (                "test_file.rs:1:",                PathLikeWithPosition {                    path_like: ("test_file.rs:1:".to_string(), "test_file.rs".to_string()),                    row: Some(1),                    column: None,                },            ),            (                "crates/file_finder/src/file_finder.rs:1902:13:",                PathLikeWithPosition {                    path_like: (                        "crates/file_finder/src/file_finder.rs:1902:13:".to_string(),                        "crates/file_finder/src/file_finder.rs".to_string(),                    ),                    row: Some(1902),                    column: Some(13),                },            ),        ];         #[cfg(target_os = "windows")]        let input_and_expected = [            (                "test_file.rs:",                PathLikeWithPosition {                    path_like: ("test_file.rs:".to_string(), "test_file.rs".to_string()),                    row: None,                    column: None,                },            ),            (                "test_file.rs:1:",                PathLikeWithPosition {                    path_like: ("test_file.rs:1:".to_string(), "test_file.rs".to_string()),                    row: Some(1),                    column: None,                },            ),            (                "\\\\?\\C:\\Users\\someone\\test_file.rs:1902:13:",                PathLikeWithPosition {                    path_like: (                        "\\\\?\\C:\\Users\\someone\\test_file.rs:1902:13:".to_string(),                        "C:\\Users\\someone\\test_file.rs".to_string(),                    ),                    row: Some(1902),                    column: Some(13),                },            ),            (                "\\\\?\\C:\\Users\\someone\\test_file.rs:1902:13:15:",                PathLikeWithPosition {                    path_like: (                        "\\\\?\\C:\\Users\\someone\\test_file.rs:1902:13:15:".to_string(),                        "C:\\Users\\someone\\test_file.rs".to_string(),                    ),                    row: Some(1902),                    column: Some(13),                },            ),            (                "\\\\?\\C:\\Users\\someone\\test_file.rs:1902:::15:",                PathLikeWithPosition {                    path_like: (                        "\\\\?\\C:\\Users\\someone\\test_file.rs:1902:::15:".to_string(),                        "C:\\Users\\someone\\test_file.rs".to_string(),                    ),                    row: Some(1902),                    column: None,                },            ),            (                "crates/utils/paths.rs",                PathLikeWithPosition {                    path_like: (                        "crates\\utils\\paths.rs".to_string(),                        "crates\\utils\\paths.rs".to_string(),                    ),                    row: None,                    column: None,                },            ),            (                "crates/utils/paths.rs:101",                PathLikeWithPosition {

Lines 1–500 of 604.