Skip to main content

rip_settings/
platform.rs

1//! Platform-specific default storage paths.
2
3use std::path::PathBuf;
4
5/// Get the default settings file path for the current platform.
6///
7/// - **Windows**: `%LOCALAPPDATA%\<app_name>\settings.json`
8/// - **macOS**: `~/Library/Application Support/<app_name>/settings.json`
9/// - **Linux**: `$XDG_DATA_HOME/<app_name>/settings.json` or `~/.local/share/<app_name>/settings.json`
10/// - **iOS**: `<HOME>/Documents/<app_name>/settings.json`
11/// - **Android**: `/data/data/<app_name>/files/settings.json`
12///
13/// **Android note:** This uses the hard-coded path `/data/data/<app_name>/files/`.
14/// In a real Android application, obtain the data directory from the Android context
15/// at runtime (e.g. via JNI) using `context.getFilesDir()` instead.
16pub fn default_settings_path(app_name: &str) -> PathBuf {
17    platform_settings_path(app_name)
18}
19
20/// Get the default path for a named settings file.
21pub fn named_settings_path(app_name: &str, file_name: &str) -> PathBuf {
22    let mut path = platform_settings_dir(app_name);
23    path.push(file_name);
24    path
25}
26
27#[cfg(target_os = "windows")]
28fn platform_settings_path(app_name: &str) -> PathBuf {
29    let mut path = platform_settings_dir(app_name);
30    path.push("settings.json");
31    path
32}
33
34#[cfg(target_os = "windows")]
35fn platform_settings_dir(app_name: &str) -> PathBuf {
36    let base = std::env::var("LOCALAPPDATA")
37        .or_else(|_| std::env::var("APPDATA"))
38        .unwrap_or_else(|_| {
39            let home = std::env::var("USERPROFILE").unwrap_or_else(|_| ".".into());
40            format!("{}\\AppData\\Local", home)
41        });
42    PathBuf::from(base).join(app_name)
43}
44
45#[cfg(target_os = "macos")]
46fn platform_settings_path(app_name: &str) -> PathBuf {
47    let mut path = platform_settings_dir(app_name);
48    path.push("settings.json");
49    path
50}
51
52#[cfg(target_os = "macos")]
53fn platform_settings_dir(app_name: &str) -> PathBuf {
54    let home = std::env::var("HOME").unwrap_or_else(|_| "/tmp".into());
55    PathBuf::from(home)
56        .join("Library")
57        .join("Application Support")
58        .join(app_name)
59}
60
61#[cfg(target_os = "linux")]
62fn platform_settings_path(app_name: &str) -> PathBuf {
63    let mut path = platform_settings_dir(app_name);
64    path.push("settings.json");
65    path
66}
67
68#[cfg(target_os = "linux")]
69fn platform_settings_dir(app_name: &str) -> PathBuf {
70    let data_home = std::env::var("XDG_DATA_HOME").unwrap_or_else(|_| {
71        let home = std::env::var("HOME").unwrap_or_else(|_| "/tmp".into());
72        format!("{}/.local/share", home)
73    });
74    PathBuf::from(data_home).join(app_name)
75}
76
77#[cfg(target_os = "ios")]
78fn platform_settings_path(app_name: &str) -> PathBuf {
79    let mut path = platform_settings_dir(app_name);
80    path.push("settings.json");
81    path
82}
83
84#[cfg(target_os = "ios")]
85fn platform_settings_dir(app_name: &str) -> PathBuf {
86    let home = std::env::var("HOME").unwrap_or_else(|_| "/tmp".into());
87    PathBuf::from(home).join("Documents").join(app_name)
88}
89
90#[cfg(target_os = "android")]
91fn platform_settings_path(app_name: &str) -> PathBuf {
92    let mut path = platform_settings_dir(app_name);
93    path.push("settings.json");
94    path
95}
96
97#[cfg(target_os = "android")]
98fn platform_settings_dir(app_name: &str) -> PathBuf {
99    PathBuf::from(format!("/data/data/{}/files", app_name))
100}
101
102#[cfg(not(any(
103    target_os = "windows",
104    target_os = "macos",
105    target_os = "linux",
106    target_os = "ios",
107    target_os = "android"
108)))]
109fn platform_settings_path(app_name: &str) -> PathBuf {
110    let mut path = platform_settings_dir(app_name);
111    path.push("settings.json");
112    path
113}
114
115#[cfg(not(any(
116    target_os = "windows",
117    target_os = "macos",
118    target_os = "linux",
119    target_os = "ios",
120    target_os = "android"
121)))]
122fn platform_settings_dir(app_name: &str) -> PathBuf {
123    PathBuf::from(".").join(app_name)
124}
125
126#[cfg(test)]
127mod tests {
128    use super::*;
129
130    #[test]
131    fn test_default_path_not_empty() {
132        let path = default_settings_path("test_app");
133        assert!(!path.as_os_str().is_empty());
134        assert!(path.to_string_lossy().contains("test_app"));
135    }
136
137    #[test]
138    fn test_named_path() {
139        let path = named_settings_path("test_app", "custom.json");
140        assert!(path.to_string_lossy().contains("custom.json"));
141    }
142}