mirror of
https://github.com/dtolnay/cargo-expand.git
synced 2025-04-02 20:37:37 +03:00
Simplify interface to obtaining cache_dir
This commit is contained in:
parent
69f8fad695
commit
a58bd1a6ca
4 changed files with 87 additions and 147 deletions
1
Cargo.lock
generated
1
Cargo.lock
generated
|
@ -197,7 +197,6 @@ version = "1.0.100"
|
|||
dependencies = [
|
||||
"bat",
|
||||
"cargo-subcommand-metadata",
|
||||
"cfg-if",
|
||||
"clap",
|
||||
"clap-cargo",
|
||||
"console",
|
||||
|
|
|
@ -19,7 +19,6 @@ prettyplease = []
|
|||
[dependencies]
|
||||
bat = { version = "0.25", default-features = false, features = ["paging", "regex-fancy"] }
|
||||
cargo-subcommand-metadata = "0.1"
|
||||
cfg-if = "1"
|
||||
clap = { version = "4", features = ["deprecated", "derive"] }
|
||||
clap-cargo = "0.15"
|
||||
console = "0.15"
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
use crate::error::Result;
|
||||
use crate::etcetera::{self, BaseStrategy as _};
|
||||
use crate::etcetera;
|
||||
use std::env;
|
||||
use std::path::PathBuf;
|
||||
use std::str;
|
||||
|
@ -21,6 +21,6 @@ pub fn cache_dir() -> Result<PathBuf> {
|
|||
return Ok(PathBuf::from(cache_dir));
|
||||
}
|
||||
|
||||
let basedirs = etcetera::choose_base_strategy()?;
|
||||
Ok(basedirs.cache_dir().join("bat"))
|
||||
let cache_dir = etcetera::cache_dir()?;
|
||||
Ok(cache_dir.join("bat"))
|
||||
}
|
||||
|
|
226
src/etcetera.rs
226
src/etcetera.rs
|
@ -1,163 +1,105 @@
|
|||
use crate::error::{Error, Result};
|
||||
use std::path::PathBuf;
|
||||
|
||||
pub mod base_strategy {
|
||||
use crate::error::Result;
|
||||
use std::path::PathBuf;
|
||||
pub fn cache_dir() -> Result<PathBuf> {
|
||||
let home_dir = home::home_dir().ok_or(Error::HomeDir)?;
|
||||
if cfg!(windows) {
|
||||
Ok(windows::cache_dir(&home_dir))
|
||||
} else {
|
||||
Ok(xdg::cache_dir(&home_dir))
|
||||
}
|
||||
}
|
||||
|
||||
pub trait BaseStrategy {
|
||||
fn cache_dir(&self) -> PathBuf;
|
||||
mod windows {
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
fn dir_inner(env: &'static str) -> Option<PathBuf> {
|
||||
std::env::var_os(env)
|
||||
.filter(|s| !s.is_empty())
|
||||
.map(PathBuf::from)
|
||||
.or_else(|| dir_crt(env))
|
||||
}
|
||||
|
||||
macro_rules! create_strategies {
|
||||
($base: ty) => {
|
||||
pub fn choose_base_strategy() -> Result<$base> {
|
||||
<$base>::new()
|
||||
}
|
||||
// Ref: https://github.com/rust-lang/cargo/blob/home-0.5.11/crates/home/src/windows.rs
|
||||
// We should keep this code in sync with the above.
|
||||
#[cfg(all(windows, not(target_vendor = "uwp")))]
|
||||
fn dir_crt(env: &'static str) -> Option<PathBuf> {
|
||||
use std::ffi::OsString;
|
||||
use std::os::windows::ffi::OsStringExt;
|
||||
use std::ptr;
|
||||
use std::slice;
|
||||
|
||||
use windows_sys::Win32::Foundation::S_OK;
|
||||
use windows_sys::Win32::System::Com::CoTaskMemFree;
|
||||
use windows_sys::Win32::UI::Shell::{
|
||||
FOLDERID_LocalAppData, FOLDERID_RoamingAppData, SHGetKnownFolderPath,
|
||||
KF_FLAG_DONT_VERIFY,
|
||||
};
|
||||
}
|
||||
|
||||
cfg_if::cfg_if! {
|
||||
if #[cfg(target_os = "windows")] {
|
||||
create_strategies!(Windows);
|
||||
} else if #[cfg(any(target_os = "macos", target_os = "ios"))] {
|
||||
create_strategies!(Xdg);
|
||||
} else {
|
||||
create_strategies!(Xdg);
|
||||
extern "C" {
|
||||
fn wcslen(buf: *const u16) -> usize;
|
||||
}
|
||||
|
||||
let folder_id = match env {
|
||||
"APPDATA" => FOLDERID_RoamingAppData,
|
||||
"LOCALAPPDATA" => FOLDERID_LocalAppData,
|
||||
_ => return None,
|
||||
};
|
||||
|
||||
unsafe {
|
||||
let mut path = ptr::null_mut();
|
||||
match SHGetKnownFolderPath(
|
||||
&folder_id,
|
||||
KF_FLAG_DONT_VERIFY as u32,
|
||||
std::ptr::null_mut(),
|
||||
&mut path,
|
||||
) {
|
||||
S_OK => {
|
||||
let path_slice = slice::from_raw_parts(path, wcslen(path));
|
||||
let s = OsString::from_wide(path_slice);
|
||||
CoTaskMemFree(path.cast());
|
||||
Some(PathBuf::from(s))
|
||||
}
|
||||
_ => {
|
||||
// Free any allocated memory even on failure. A null ptr is a no-op for `CoTaskMemFree`.
|
||||
CoTaskMemFree(path.cast());
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
mod windows {
|
||||
use crate::error::Result;
|
||||
use std::path::PathBuf;
|
||||
#[cfg(not(all(windows, not(target_vendor = "uwp"))))]
|
||||
fn dir_crt(_env: &'static str) -> Option<PathBuf> {
|
||||
None
|
||||
}
|
||||
|
||||
pub struct Windows {
|
||||
home_dir: PathBuf,
|
||||
}
|
||||
pub fn cache_dir(home_dir: &Path) -> PathBuf {
|
||||
dir_inner("LOCALAPPDATA").unwrap_or_else(|| home_dir.join("AppData").join("Local"))
|
||||
}
|
||||
}
|
||||
|
||||
impl Windows {
|
||||
pub fn new() -> Result<Self> {
|
||||
Ok(Self {
|
||||
home_dir: crate::etcetera::home_dir()?,
|
||||
})
|
||||
}
|
||||
mod xdg {
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
fn dir_inner(env: &'static str) -> Option<PathBuf> {
|
||||
std::env::var_os(env)
|
||||
.filter(|s| !s.is_empty())
|
||||
.map(PathBuf::from)
|
||||
.or_else(|| Self::dir_crt(env))
|
||||
}
|
||||
fn env_var_or_none(env_var: &str) -> Option<PathBuf> {
|
||||
std::env::var(env_var).ok().and_then(|path| {
|
||||
let path = PathBuf::from(path);
|
||||
|
||||
// Ref: https://github.com/rust-lang/cargo/blob/home-0.5.11/crates/home/src/windows.rs
|
||||
// We should keep this code in sync with the above.
|
||||
#[cfg(all(windows, not(target_vendor = "uwp")))]
|
||||
fn dir_crt(env: &'static str) -> Option<PathBuf> {
|
||||
use std::ffi::OsString;
|
||||
use std::os::windows::ffi::OsStringExt;
|
||||
use std::ptr;
|
||||
use std::slice;
|
||||
|
||||
use windows_sys::Win32::Foundation::S_OK;
|
||||
use windows_sys::Win32::System::Com::CoTaskMemFree;
|
||||
use windows_sys::Win32::UI::Shell::{
|
||||
FOLDERID_LocalAppData, FOLDERID_RoamingAppData, SHGetKnownFolderPath,
|
||||
KF_FLAG_DONT_VERIFY,
|
||||
};
|
||||
|
||||
extern "C" {
|
||||
fn wcslen(buf: *const u16) -> usize;
|
||||
}
|
||||
|
||||
let folder_id = match env {
|
||||
"APPDATA" => FOLDERID_RoamingAppData,
|
||||
"LOCALAPPDATA" => FOLDERID_LocalAppData,
|
||||
_ => return None,
|
||||
};
|
||||
|
||||
unsafe {
|
||||
let mut path = ptr::null_mut();
|
||||
match SHGetKnownFolderPath(
|
||||
&folder_id,
|
||||
KF_FLAG_DONT_VERIFY as u32,
|
||||
std::ptr::null_mut(),
|
||||
&mut path,
|
||||
) {
|
||||
S_OK => {
|
||||
let path_slice = slice::from_raw_parts(path, wcslen(path));
|
||||
let s = OsString::from_wide(path_slice);
|
||||
CoTaskMemFree(path.cast());
|
||||
Some(PathBuf::from(s))
|
||||
}
|
||||
_ => {
|
||||
// Free any allocated memory even on failure. A null ptr is a no-op for `CoTaskMemFree`.
|
||||
CoTaskMemFree(path.cast());
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(not(all(windows, not(target_vendor = "uwp"))))]
|
||||
fn dir_crt(_env: &'static str) -> Option<PathBuf> {
|
||||
// Return None if the path obtained from the environment variable isn’t absolute.
|
||||
if path.is_absolute() {
|
||||
Some(path)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
||||
impl super::BaseStrategy for Windows {
|
||||
fn cache_dir(&self) -> PathBuf {
|
||||
Self::dir_inner("LOCALAPPDATA")
|
||||
.unwrap_or_else(|| self.home_dir.join("AppData").join("Local"))
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
mod xdg {
|
||||
use crate::error::Result;
|
||||
use std::path::Path;
|
||||
use std::path::PathBuf;
|
||||
|
||||
pub struct Xdg {
|
||||
home_dir: PathBuf,
|
||||
}
|
||||
|
||||
impl Xdg {
|
||||
pub fn new() -> Result<Self> {
|
||||
Ok(Self {
|
||||
home_dir: crate::etcetera::home_dir()?,
|
||||
})
|
||||
}
|
||||
|
||||
fn env_var_or_none(env_var: &str) -> Option<PathBuf> {
|
||||
std::env::var(env_var).ok().and_then(|path| {
|
||||
let path = PathBuf::from(path);
|
||||
|
||||
// Return None if the path obtained from the environment variable isn’t absolute.
|
||||
if path.is_absolute() {
|
||||
Some(path)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn env_var_or_default(&self, env_var: &str, default: impl AsRef<Path>) -> PathBuf {
|
||||
Self::env_var_or_none(env_var).unwrap_or_else(|| self.home_dir.join(default))
|
||||
}
|
||||
}
|
||||
|
||||
impl super::BaseStrategy for Xdg {
|
||||
fn cache_dir(&self) -> PathBuf {
|
||||
self.env_var_or_default("XDG_CACHE_HOME", ".cache/")
|
||||
}
|
||||
}
|
||||
fn env_var_or_default(home_dir: &Path, env_var: &str, default: impl AsRef<Path>) -> PathBuf {
|
||||
env_var_or_none(env_var).unwrap_or_else(|| home_dir.join(default))
|
||||
}
|
||||
|
||||
pub use windows::Windows;
|
||||
pub use xdg::Xdg;
|
||||
}
|
||||
|
||||
pub use base_strategy::{choose_base_strategy, BaseStrategy};
|
||||
|
||||
pub fn home_dir() -> Result<std::path::PathBuf> {
|
||||
home::home_dir().ok_or(Error::HomeDir)
|
||||
pub fn cache_dir(home_dir: &Path) -> PathBuf {
|
||||
env_var_or_default(home_dir, "XDG_CACHE_HOME", ".cache/")
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue