Remove cfg-if crate

This commit is contained in:
Zhenping Zhao
2024-11-23 10:56:03 -08:00
parent e9461395e9
commit 9f56b1d64e
6 changed files with 284 additions and 302 deletions

View File

@ -13,7 +13,6 @@ bench = false
[dependencies] [dependencies]
dirs = { workspace = true } dirs = { workspace = true }
cfg-if = "1.0.0"
[target.'cfg(windows)'.dependencies] [target.'cfg(windows)'.dependencies]
omnipath = { workspace = true } omnipath = { workspace = true }

View File

@ -6,6 +6,7 @@ pub mod expansions;
pub mod form; pub mod form;
mod helpers; mod helpers;
mod path; mod path;
#[cfg(windows)]
pub mod pwd_per_drive; pub mod pwd_per_drive;
mod tilde; mod tilde;
mod trailing_slash; mod trailing_slash;
@ -14,6 +15,7 @@ pub use components::components;
pub use expansions::{canonicalize_with, expand_path_with, expand_to_real_path, locate_in_dirs}; pub use expansions::{canonicalize_with, expand_path_with, expand_to_real_path, locate_in_dirs};
pub use helpers::{cache_dir, data_dir, home_dir, nu_config_dir}; pub use helpers::{cache_dir, data_dir, home_dir, nu_config_dir};
pub use path::*; pub use path::*;
pub use pwd_per_drive::pwd_per_drive_singleton::{expand_pwd_per_drive, set_pwd_per_drive}; #[cfg(windows)]
pub use pwd_per_drive::_impl::singleton::{expand_pwd, set_pwd};
pub use tilde::expand_tilde; pub use tilde::expand_tilde;
pub use trailing_slash::{has_trailing_slash, strip_trailing_slash}; pub use trailing_slash::{has_trailing_slash, strip_trailing_slash};

View File

@ -1,15 +1,14 @@
#[cfg(windows)]
pub mod _impl {
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
cfg_if::cfg_if! { if #[cfg(windows)] { struct Drive2PWD {
struct Drive2PWDmap {
map: [Option<String>; 26], // Fixed-size array for A-Z map: [Option<String>; 26], // Fixed-size array for A-Z
} }
impl Drive2PWDmap { impl Drive2PWD {
pub fn new() -> Self { pub fn new() -> Self {
Drive2PWDmap { Drive2PWD {
map: Default::default(), // Initialize all to `None` map: Default::default(), // Initialize all to `None`
} }
} }
@ -17,10 +16,9 @@ impl Drive2PWDmap {
/// Set the PWD for the drive letter in the absolute path. /// Set the PWD for the drive letter in the absolute path.
/// Return String for error description. /// Return String for error description.
pub fn set_pwd(&mut self, path: &Path) -> Result<(), String> { pub fn set_pwd(&mut self, path: &Path) -> Result<(), String> {
if let (Some(drive_letter), Some(path_str)) = ( if let (Some(drive_letter), Some(path_str)) =
Self::extract_drive_letter(path), (Self::extract_drive_letter(path), path.to_str())
path.to_str(), {
) {
self.map[drive_letter as usize - 'A' as usize] = Some(path_str.to_string()); self.map[drive_letter as usize - 'A' as usize] = Some(path_str.to_string());
return Ok(()); return Ok(());
} }
@ -33,17 +31,14 @@ impl Drive2PWDmap {
if drive.is_ascii_alphabetic() { if drive.is_ascii_alphabetic() {
let drive = drive.to_ascii_uppercase(); let drive = drive.to_ascii_uppercase();
let index = drive as usize - 'A' as usize; let index = drive as usize - 'A' as usize;
Some(self.map[index] Some(self.map[index].clone().unwrap_or_else(|| {
.clone()
.unwrap_or_else(||
if let Some(system_pwd) = get_full_path_name_w(&format!("{}:", drive)) { if let Some(system_pwd) = get_full_path_name_w(&format!("{}:", drive)) {
self.map[index] = Some(system_pwd.clone()); self.map[index] = Some(system_pwd.clone());
system_pwd system_pwd
} else { } else {
format!(r"{}:\", drive) format!(r"{}:\", drive)
} }
) }))
)
} else { } else {
None None
} }
@ -59,7 +54,7 @@ impl Drive2PWDmap {
// Combine current PWD with the relative path // Combine current PWD with the relative path
let mut base = PathBuf::from(Self::ensure_trailing_separator(&pwd)); let mut base = PathBuf::from(Self::ensure_trailing_separator(&pwd));
base.push(path_str.split_at(2).1); // Skip the "C:" part of the relative path base.push(path_str.split_at(2).1); // Skip the "C:" part of the relative path
return Some(base) return Some(base);
} }
} }
None // Invalid path or has no drive letter None // Invalid path or has no drive letter
@ -67,9 +62,10 @@ impl Drive2PWDmap {
/// Extract the drive letter from a path (e.g., `C:test` -> `C`) /// Extract the drive letter from a path (e.g., `C:test` -> `C`)
fn extract_drive_letter(path: &Path) -> Option<char> { fn extract_drive_letter(path: &Path) -> Option<char> {
Some(path.to_str() Some(
path.to_str()
.and_then(|s| s.chars().next()) .and_then(|s| s.chars().next())
.filter(|c| c.is_ascii_alphabetic())? .filter(|c| c.is_ascii_alphabetic())?,
) )
} }
@ -83,11 +79,11 @@ impl Drive2PWDmap {
} }
} }
// GetFullPathW // Wrapper of Win32 API GetFullPathW()
fn get_full_path_name_w(path_str: &str) -> Option<String> { fn get_full_path_name_w(path_str: &str) -> Option<String> {
use std::ffi::OsString; use std::ffi::OsString;
use std::os::windows::ffi::OsStringExt;
use std::os::windows::ffi::OsStrExt; use std::os::windows::ffi::OsStrExt;
use std::os::windows::ffi::OsStringExt;
use winapi::um::fileapi::GetFullPathNameW; use winapi::um::fileapi::GetFullPathNameW;
const MAX_PATH: usize = 260; const MAX_PATH: usize = 260;
@ -95,7 +91,10 @@ fn get_full_path_name_w(path_str: &str) -> Option<String> {
unsafe { unsafe {
// Convert input to wide string. // Convert input to wide string.
let wide_path: Vec<u16> = OsString::from(path_str).encode_wide().chain(Some(0)).collect(); let wide_path: Vec<u16> = OsString::from(path_str)
.encode_wide()
.chain(Some(0))
.collect();
let length = GetFullPathNameW( let length = GetFullPathNameW(
wide_path.as_ptr(), wide_path.as_ptr(),
buffer.len() as u32, buffer.len() as u32,
@ -117,16 +116,16 @@ fn get_full_path_name_w(path_str: &str) -> Option<String> {
} }
/// Global singleton instance of DrivePwdMap /// Global singleton instance of DrivePwdMap
use std::sync::{Once, Mutex}; use std::sync::{Mutex, Once};
static INIT: Once = Once::new(); static INIT: Once = Once::new();
static mut DRIVE_PWD_MAP: Option<Mutex<Drive2PWDmap>> = None; static mut DRIVE_PWD_MAP: Option<Mutex<Drive2PWD>> = None;
/// Access the singleton instance /// Access the singleton instance
fn get_drive_pwd_map() -> &'static Mutex<Drive2PWDmap> { fn get_drive_pwd_map() -> &'static Mutex<Drive2PWD> {
unsafe { unsafe {
INIT.call_once(|| { INIT.call_once(|| {
DRIVE_PWD_MAP = Some(Mutex::new(Drive2PWDmap::new())); DRIVE_PWD_MAP = Some(Mutex::new(Drive2PWD::new()));
}); });
DRIVE_PWD_MAP.as_ref().unwrap() DRIVE_PWD_MAP.as_ref().unwrap()
} }
@ -170,7 +169,7 @@ mod tests {
#[test] #[test]
fn test_expand_path() { fn test_expand_path() {
let mut drive_map = Drive2PWDmap::new(); let mut drive_map = Drive2PWD::new();
// Set PWD for drive C // Set PWD for drive C
assert_eq!(drive_map.set_pwd(Path::new(r"C:\Users\Home")), Ok(())); assert_eq!(drive_map.set_pwd(Path::new(r"C:\Users\Home")), Ok(()));
@ -190,7 +189,13 @@ mod tests {
// Expand with no PWD set for the drive // Expand with no PWD set for the drive
let expanded = drive_map.expand_path(Path::new("D:test")); let expanded = drive_map.expand_path(Path::new("D:test"));
if let Some(pwd_on_d) = get_full_path_name_w("D:") { if let Some(pwd_on_d) = get_full_path_name_w("D:") {
assert_eq!(expanded, Some(PathBuf::from(format!(r"{}test", Drive2PWDmap::ensure_trailing_separator(&pwd_on_d))))); assert_eq!(
expanded,
Some(PathBuf::from(format!(
r"{}test",
Drive2PWD::ensure_trailing_separator(&pwd_on_d)
)))
);
} else { } else {
assert_eq!(expanded, Some(PathBuf::from(r"D:\test"))); assert_eq!(expanded, Some(PathBuf::from(r"D:\test")));
} }
@ -198,11 +203,14 @@ mod tests {
#[test] #[test]
fn test_set_and_get_pwd() { fn test_set_and_get_pwd() {
let mut drive_map = Drive2PWDmap::new(); let mut drive_map = Drive2PWD::new();
// Set PWD for drive C // Set PWD for drive C
assert!(drive_map.set_pwd(Path::new(r"C:\Users\Example")).is_ok()); assert!(drive_map.set_pwd(Path::new(r"C:\Users\Example")).is_ok());
assert_eq!(drive_map.get_pwd('C'), Some(r"C:\Users\Example".to_string())); assert_eq!(
drive_map.get_pwd('C'),
Some(r"C:\Users\Example".to_string())
);
// Set PWD for drive D // Set PWD for drive D
assert!(drive_map.set_pwd(Path::new(r"D:\Projects")).is_ok()); assert!(drive_map.set_pwd(Path::new(r"D:\Projects")).is_ok());
@ -223,7 +231,7 @@ mod tests {
#[test] #[test]
fn test_set_pwd_invalid_path() { fn test_set_pwd_invalid_path() {
let mut drive_map = Drive2PWDmap::new(); let mut drive_map = Drive2PWD::new();
// Invalid path (no drive letter) // Invalid path (no drive letter)
let result = drive_map.set_pwd(Path::new(r"\InvalidPath")); let result = drive_map.set_pwd(Path::new(r"\InvalidPath"));
@ -233,7 +241,7 @@ mod tests {
#[test] #[test]
fn test_get_pwd_invalid_drive() { fn test_get_pwd_invalid_drive() {
let mut drive_map = Drive2PWDmap::new(); let mut drive_map = Drive2PWD::new();
// Get PWD for a drive not set (e.g., Z) // Get PWD for a drive not set (e.g., Z)
assert_eq!(drive_map.get_pwd('Z'), Some(r"Z:\".to_string())); assert_eq!(drive_map.get_pwd('Z'), Some(r"Z:\".to_string()));
@ -243,8 +251,6 @@ mod tests {
} }
} }
}} // cfg_if! if #[cfg(windows)]
/// Usage for pwd_per_drive on windows /// Usage for pwd_per_drive on windows
/// ///
/// Upon change PWD, call set_pwd_per_drive() with absolute path /// Upon change PWD, call set_pwd_per_drive() with absolute path
@ -253,114 +259,86 @@ mod tests {
/// ///
/// ``` /// ```
/// use std::path::{Path, PathBuf}; /// use std::path::{Path, PathBuf};
/// use nu_path::{expand_pwd_per_drive, set_pwd_per_drive}; /// use nu_path::{expand_pwd, set_pwd};
/// ///
/// //assert!(false); // Comment out to verify really tested
/// if cfg!(windows) {
/// // Set PWD for drive C /// // Set PWD for drive C
/// set_pwd_per_drive(Path::new(r"C:\Users\Home")).unwrap(); /// set_pwd(Path::new(r"C:\Users\Home")).unwrap();
/// ///
/// // Expand a relative path /// // Expand a relative path
/// let expanded = expand_pwd_per_drive(Path::new("C:test")); /// let expanded = expand_pwd(Path::new("C:test"));
/// assert_eq!(expanded, Some(PathBuf::from(r"C:\Users\Home\test"))); /// assert_eq!(expanded, Some(PathBuf::from(r"C:\Users\Home\test")));
/// ///
/// // Will NOT expand an absolute path /// // Will NOT expand an absolute path
/// let expanded = expand_pwd_per_drive(Path::new(r"C:\absolute\path")); /// let expanded = expand_pwd(Path::new(r"C:\absolute\path"));
/// assert_eq!(expanded, None); /// assert_eq!(expanded, None);
/// ///
/// // Expand with no drive letter /// // Expand with no drive letter
/// let expanded = expand_pwd_per_drive(Path::new(r"\no_drive")); /// let expanded = expand_pwd(Path::new(r"\no_drive"));
/// assert_eq!(expanded, None); /// assert_eq!(expanded, None);
/// ///
/// // Expand with no PWD set for the drive /// // Expand with no PWD set for the drive
/// let expanded = expand_pwd_per_drive(Path::new("D:test")); /// let expanded = expand_pwd(Path::new("D:test"));
/// assert_eq!(expanded, Some(PathBuf::from(r"D:\test"))); /// assert_eq!(expanded, Some(PathBuf::from(r"D:\test")));
/// }
/// ``` /// ```
pub mod pwd_per_drive_singleton { pub mod singleton {
use super::*; use super::*;
/// set_pwd_per_drive /// set_pwd_per_drive
/// On Windows, record PWD for drive, path must be absolute path /// Record PWD for drive, path must be absolute path
/// return Ok(()) if succeeded, otherwise error message /// return Ok(()) if succeeded, otherwise error message
/// Other platforms, return Ok(()) pub fn set_pwd(_path: &Path) -> Result<(), String> {
pub fn set_pwd_per_drive(_path: &Path) -> Result<(), String> {
cfg_if::cfg_if! { if #[cfg(target_os="windows")] {
if let Ok(mut pwd_per_drive) = get_drive_pwd_map().lock() { if let Ok(mut pwd_per_drive) = get_drive_pwd_map().lock() {
pwd_per_drive.set_pwd(_path) pwd_per_drive.set_pwd(_path)
} else { } else {
Err("Failed to lock map".to_string()) Err("Failed to lock map".to_string())
} }
} else {
Ok(())
}}
} }
/// expand_pwe_per_drive /// expand_pwe_per_drive
/// On windows, input relative path, expand PWD-per-drive to construct absolute path /// Input relative path, expand PWD-per-drive to construct absolute path
/// return PathBuf for absolute path, None if input path is invalid. /// return PathBuf for absolute path, None if input path is invalid.
/// Otherwise, return None. pub fn expand_pwd(_path: &Path) -> Option<PathBuf> {
pub fn expand_pwd_per_drive(_path: &Path) -> Option<PathBuf> {
cfg_if::cfg_if! { if #[cfg(target_os="windows")] {
if need_expand_pwd_per_drive(_path) { if need_expand_pwd_per_drive(_path) {
if let Ok(mut pwd_per_drive) = get_drive_pwd_map().lock() { if let Ok(mut pwd_per_drive) = get_drive_pwd_map().lock() {
return pwd_per_drive.expand_path(_path); return pwd_per_drive.expand_path(_path);
} }
} }
}}
None None
} }
cfg_if::cfg_if! { if #[cfg(target_os="windows")] {
/// Helper only used on Windows, if input path is relative path /// Helper only used on Windows, if input path is relative path
/// with drive letter, it can be expanded with PWD-per-drive. /// with drive letter, it can be expanded with PWD-per-drive.
fn need_expand_pwd_per_drive(_path: &Path) -> bool { fn need_expand_pwd_per_drive(_path: &Path) -> bool {
if let Some(path_str) = _path.to_str() { if let Some(path_str) = _path.to_str() {
let chars: Vec<char> = path_str.chars().collect(); let chars: Vec<char> = path_str.chars().collect();
if chars.len() >= 2 { if chars.len() >= 2 {
return chars[1] == ':' && return chars[1] == ':'
(chars.len() == 2 || && (chars.len() == 2 || (chars[2] != '/' && chars[2] != '\\'));
(chars[2] != '/' &&
chars[2] != '\\'
)
);
} }
} }
false false
} }
}}
#[test] #[test]
fn test_usage_for_pwd_per_drive() { fn test_usage_for_pwd_per_drive() {
// Set PWD for drive F // Set PWD for drive F
assert!(set_pwd_per_drive(Path::new(r"F:\Users\Home")).is_ok()); assert!(set_pwd(Path::new(r"F:\Users\Home")).is_ok());
if cfg!(windows) {
// Expand a relative path // Expand a relative path
let expanded = expand_pwd_per_drive(Path::new("f:test")); let expanded = expand_pwd(Path::new("f:test"));
assert_eq!(expanded, Some(PathBuf::from(r"F:\Users\Home\test"))); assert_eq!(expanded, Some(PathBuf::from(r"F:\Users\Home\test")));
// Will NOT expand an absolute path // Will NOT expand an absolute path
let expanded = expand_pwd_per_drive(Path::new(r"F:\absolute\path")); let expanded = expand_pwd(Path::new(r"F:\absolute\path"));
assert_eq!(expanded, None); assert_eq!(expanded, None);
// Expand with no drive letter // Expand with no drive letter
let expanded = expand_pwd_per_drive(Path::new(r"\no_drive")); let expanded = expand_pwd(Path::new(r"\no_drive"));
assert_eq!(expanded, None); assert_eq!(expanded, None);
// Expand with no PWD set for the drive // Expand with no PWD set for the drive
let expanded = expand_pwd_per_drive(Path::new("G:test")); let expanded = expand_pwd(Path::new("G:test"));
assert_eq!(expanded, Some(PathBuf::from(r"G:\test"))); assert_eq!(expanded, Some(PathBuf::from(r"G:\test")));
} else {
// None always
assert_eq!(None, expand_pwd_per_drive(Path::new("F:test")));
} }
} }
} }

View File

@ -22,7 +22,8 @@ fn expand_tilde_with_home(path: impl AsRef<Path>, home: Option<PathBuf>) -> Path
if !path.starts_with("~") { if !path.starts_with("~") {
// Try to expand relative path by PWD-per-drive // Try to expand relative path by PWD-per-drive
if let Some(expanded_dir) = crate::expand_pwd_per_drive(path) { #[cfg(windows)]
if let Some(expanded_dir) = crate::expand_pwd(path) {
return expanded_dir; return expanded_dir;
} }
let string = path.to_string_lossy(); let string = path.to_string_lossy();

View File

@ -957,7 +957,8 @@ impl EngineState {
} else if !path.is_dir() { } else if !path.is_dir() {
Err(error("$env.PWD points to a non-directory", &path)) Err(error("$env.PWD points to a non-directory", &path))
} else { } else {
let _ = nu_path::set_pwd_per_drive(path.as_std_path()); #[cfg(windows)]
let _ = nu_path::set_pwd(path.as_std_path());
Ok(path) Ok(path)
} }
} else { } else {

View File

@ -727,7 +727,8 @@ impl Stack {
let value = Value::string(path.to_string_lossy(), Span::unknown()); let value = Value::string(path.to_string_lossy(), Span::unknown());
self.add_env_var("PWD".into(), value); self.add_env_var("PWD".into(), value);
// Sync with PWD-per-drive // Sync with PWD-per-drive
let _ = nu_path::set_pwd_per_drive(&path); #[cfg(windows)]
let _ = nu_path::set_pwd(&path);
Ok(()) Ok(())
} }
} }