glib/utils.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
// Take a look at the license at the top of the repository in the LICENSE file.
use std::{
ffi::{OsStr, OsString},
mem, ptr,
};
use crate::{ffi, translate::*, GString};
// rustdoc-stripper-ignore-next
/// Same as [`get_prgname()`].
///
/// [`get_prgname()`]: fn.get_prgname.html
#[doc(alias = "get_program_name")]
#[inline]
pub fn program_name() -> Option<GString> {
prgname()
}
#[doc(alias = "g_get_prgname")]
#[doc(alias = "get_prgname")]
#[inline]
pub fn prgname() -> Option<GString> {
unsafe { from_glib_none(ffi::g_get_prgname()) }
}
// rustdoc-stripper-ignore-next
/// Same as [`set_prgname()`].
///
/// [`set_prgname()`]: fn.set_prgname.html
#[inline]
pub fn set_program_name(name: Option<impl IntoGStr>) {
set_prgname(name)
}
#[doc(alias = "g_set_prgname")]
#[inline]
pub fn set_prgname(name: Option<impl IntoGStr>) {
name.run_with_gstr(|name| unsafe { ffi::g_set_prgname(name.to_glib_none().0) })
}
#[doc(alias = "g_environ_getenv")]
pub fn environ_getenv<K: AsRef<OsStr>>(envp: &[OsString], variable: K) -> Option<OsString> {
unsafe {
from_glib_none(ffi::g_environ_getenv(
envp.to_glib_none().0,
variable.as_ref().to_glib_none().0,
))
}
}
/// Opens a temporary file. See the mkstemp() documentation
/// on most UNIX-like systems.
///
/// The parameter is a string that should follow the rules for
/// mkstemp() templates, i.e. contain the string "XXXXXX".
/// g_mkstemp() is slightly more flexible than mkstemp() in that the
/// sequence does not have to occur at the very end of the template.
/// The X string will be modified to form the name of a file that
/// didn't exist. The string should be in the GLib file name encoding.
/// Most importantly, on Windows it should be in UTF-8.
/// ## `tmpl`
/// template filename
///
/// # Returns
///
/// A file handle (as from open()) to the file
/// opened for reading and writing. The file is opened in binary
/// mode on platforms where there is a difference. The file handle
/// should be closed with close(). In case of errors, -1 is
/// returned and `errno` will be set.
#[doc(alias = "g_mkstemp")]
pub fn mkstemp<P: AsRef<std::path::Path>>(tmpl: P) -> i32 {
unsafe {
// NOTE: This modifies the string in place, which is fine here because
// to_glib_none() will create a temporary, NUL-terminated copy of the string.
ffi::g_mkstemp(tmpl.as_ref().to_glib_none().0)
}
}
/// Opens a temporary file. See the mkstemp() documentation
/// on most UNIX-like systems.
///
/// The parameter is a string that should follow the rules for
/// mkstemp() templates, i.e. contain the string "XXXXXX".
/// g_mkstemp_full() is slightly more flexible than mkstemp()
/// in that the sequence does not have to occur at the very end of the
/// template and you can pass a @mode and additional @flags. The X
/// string will be modified to form the name of a file that didn't exist.
/// The string should be in the GLib file name encoding. Most importantly,
/// on Windows it should be in UTF-8.
/// ## `tmpl`
/// template filename
/// ## `flags`
/// flags to pass to an open() call in addition to O_EXCL
/// and O_CREAT, which are passed automatically
/// ## `mode`
/// permissions to create the temporary file with
///
/// # Returns
///
/// A file handle (as from open()) to the file
/// opened for reading and writing. The file handle should be
/// closed with close(). In case of errors, -1 is returned
/// and `errno` will be set.
#[doc(alias = "g_mkstemp_full")]
pub fn mkstemp_full(tmpl: impl AsRef<std::path::Path>, flags: i32, mode: i32) -> i32 {
unsafe {
// NOTE: This modifies the string in place, which is fine here because
// to_glib_none() will create a temporary, NUL-terminated copy of the string.
ffi::g_mkstemp_full(tmpl.as_ref().to_glib_none().0, flags, mode)
}
}
/// Creates a temporary directory. See the mkdtemp() documentation
/// on most UNIX-like systems.
///
/// The parameter is a string that should follow the rules for
/// mkdtemp() templates, i.e. contain the string "XXXXXX".
/// g_mkdtemp() is slightly more flexible than mkdtemp() in that the
/// sequence does not have to occur at the very end of the template.
/// The X string will be modified to form the name of a directory that
/// didn't exist.
/// The string should be in the GLib file name encoding. Most importantly,
/// on Windows it should be in UTF-8.
///
/// If you are going to be creating a temporary directory inside the
/// directory returned by g_get_tmp_dir(), you might want to use
/// g_dir_make_tmp() instead.
/// ## `tmpl`
/// template directory name
///
/// # Returns
///
/// A pointer to @tmpl, which has been
/// modified to hold the directory name. In case of errors, [`None`] is
/// returned and `errno` will be set.
#[doc(alias = "g_mkdtemp")]
pub fn mkdtemp(tmpl: impl AsRef<std::path::Path>) -> Option<std::path::PathBuf> {
unsafe {
// NOTE: This modifies the string in place and returns it but does not free it
// if it returns NULL.
let tmpl = tmpl.as_ref().to_glib_full();
let res = ffi::g_mkdtemp(tmpl);
if res.is_null() {
ffi::g_free(tmpl as ffi::gpointer);
None
} else {
from_glib_full(res)
}
}
}
/// Creates a temporary directory. See the mkdtemp() documentation
/// on most UNIX-like systems.
///
/// The parameter is a string that should follow the rules for
/// mkdtemp() templates, i.e. contain the string "XXXXXX".
/// g_mkdtemp_full() is slightly more flexible than mkdtemp() in that the
/// sequence does not have to occur at the very end of the template
/// and you can pass a @mode. The X string will be modified to form
/// the name of a directory that didn't exist. The string should be
/// in the GLib file name encoding. Most importantly, on Windows it
/// should be in UTF-8.
///
/// If you are going to be creating a temporary directory inside the
/// directory returned by g_get_tmp_dir(), you might want to use
/// g_dir_make_tmp() instead.
/// ## `tmpl`
/// template directory name
/// ## `mode`
/// permissions to create the temporary directory with
///
/// # Returns
///
/// A pointer to @tmpl, which has been
/// modified to hold the directory name. In case of errors, [`None`] is
/// returned, and `errno` will be set.
#[doc(alias = "g_mkdtemp_full")]
pub fn mkdtemp_full(tmpl: impl AsRef<std::path::Path>, mode: i32) -> Option<std::path::PathBuf> {
unsafe {
// NOTE: This modifies the string in place and returns it but does not free it
// if it returns NULL.
let tmpl = tmpl.as_ref().to_glib_full();
let res = ffi::g_mkdtemp_full(tmpl, mode);
if res.is_null() {
ffi::g_free(tmpl as ffi::gpointer);
None
} else {
from_glib_full(res)
}
}
}
/// Reads an entire file into allocated memory, with good error
/// checking.
///
/// If the call was successful, it returns [`true`] and sets @contents to the file
/// contents and @length to the length of the file contents in bytes. The string
/// stored in @contents will be nul-terminated, so for text files you can pass
/// [`None`] for the @length argument. If the call was not successful, it returns
/// [`false`] and sets @error. The error domain is `G_FILE_ERROR`. Possible error
/// codes are those in the #GFileError enumeration. In the error case,
/// @contents is set to [`None`] and @length is set to zero.
/// ## `filename`
/// name of a file to read contents from, in the GLib file name encoding
///
/// # Returns
///
/// [`true`] on success, [`false`] if an error occurred
///
/// ## `contents`
/// location to store an allocated string, use g_free() to free
/// the returned string
#[doc(alias = "g_file_get_contents")]
pub fn file_get_contents(
filename: impl AsRef<std::path::Path>,
) -> Result<crate::Slice<u8>, crate::Error> {
unsafe {
let mut contents = ptr::null_mut();
let mut length = mem::MaybeUninit::uninit();
let mut error = ptr::null_mut();
let _ = ffi::g_file_get_contents(
filename.as_ref().to_glib_none().0,
&mut contents,
length.as_mut_ptr(),
&mut error,
);
if error.is_null() {
Ok(crate::Slice::from_glib_full_num(
contents,
length.assume_init() as _,
))
} else {
Err(from_glib_full(error))
}
}
}
pub fn is_canonical_pspec_name(name: &str) -> bool {
name.as_bytes().iter().enumerate().all(|(i, c)| {
i != 0 && (*c >= b'0' && *c <= b'9' || *c == b'-')
|| (*c >= b'A' && *c <= b'Z')
|| (*c >= b'a' && *c <= b'z')
})
}
#[doc(alias = "g_uri_escape_string")]
pub fn uri_escape_string(
unescaped: impl IntoGStr,
reserved_chars_allowed: Option<impl IntoGStr>,
allow_utf8: bool,
) -> crate::GString {
unescaped.run_with_gstr(|unescaped| {
reserved_chars_allowed.run_with_gstr(|reserved_chars_allowed| unsafe {
from_glib_full(ffi::g_uri_escape_string(
unescaped.to_glib_none().0,
reserved_chars_allowed.to_glib_none().0,
allow_utf8.into_glib(),
))
})
})
}
#[doc(alias = "g_uri_unescape_string")]
pub fn uri_unescape_string(
escaped_string: impl IntoGStr,
illegal_characters: Option<impl IntoGStr>,
) -> Option<crate::GString> {
escaped_string.run_with_gstr(|escaped_string| {
illegal_characters.run_with_gstr(|illegal_characters| unsafe {
from_glib_full(ffi::g_uri_unescape_string(
escaped_string.to_glib_none().0,
illegal_characters.to_glib_none().0,
))
})
})
}
#[doc(alias = "g_uri_parse_scheme")]
pub fn uri_parse_scheme(uri: impl IntoGStr) -> Option<crate::GString> {
uri.run_with_gstr(|uri| unsafe {
from_glib_full(ffi::g_uri_parse_scheme(uri.to_glib_none().0))
})
}
#[doc(alias = "g_uri_unescape_segment")]
pub fn uri_unescape_segment(
escaped_string: Option<impl IntoGStr>,
escaped_string_end: Option<impl IntoGStr>,
illegal_characters: Option<impl IntoGStr>,
) -> Option<crate::GString> {
escaped_string.run_with_gstr(|escaped_string| {
escaped_string_end.run_with_gstr(|escaped_string_end| {
illegal_characters.run_with_gstr(|illegal_characters| unsafe {
from_glib_full(ffi::g_uri_unescape_segment(
escaped_string.to_glib_none().0,
escaped_string_end.to_glib_none().0,
illegal_characters.to_glib_none().0,
))
})
})
})
}
#[cfg(test)]
mod tests {
use std::{env, sync::Mutex, sync::OnceLock};
//Mutex to prevent run environment tests parallel
fn lock() -> &'static Mutex<()> {
static LOCK: OnceLock<Mutex<()>> = OnceLock::new();
LOCK.get_or_init(|| Mutex::new(()))
}
const VAR_NAME: &str = "function_environment_test";
fn check_getenv(val: &str) {
let _data = lock().lock().unwrap();
env::set_var(VAR_NAME, val);
assert_eq!(env::var_os(VAR_NAME), Some(val.into()));
assert_eq!(crate::getenv(VAR_NAME), Some(val.into()));
let environ = crate::environ();
assert_eq!(crate::environ_getenv(&environ, VAR_NAME), Some(val.into()));
}
fn check_setenv(val: &str) {
let _data = lock().lock().unwrap();
crate::setenv(VAR_NAME, val, true).unwrap();
assert_eq!(env::var_os(VAR_NAME), Some(val.into()));
}
#[test]
fn getenv() {
check_getenv("Test");
check_getenv("Тест"); // "Test" in Russian
}
#[test]
fn setenv() {
check_setenv("Test");
check_setenv("Тест"); // "Test" in Russian
}
#[test]
fn test_filename_from_uri() {
use std::path::PathBuf;
use crate::GString;
let uri: GString = "file:///foo/bar.txt".into();
if let Ok((filename, hostname)) = crate::filename_from_uri(&uri) {
assert_eq!(filename, PathBuf::from(r"/foo/bar.txt"));
assert_eq!(hostname, None);
} else {
unreachable!();
}
let uri: GString = "file://host/foo/bar.txt".into();
if let Ok((filename, hostname)) = crate::filename_from_uri(&uri) {
assert_eq!(filename, PathBuf::from(r"/foo/bar.txt"));
assert_eq!(hostname, Some(GString::from("host")));
} else {
unreachable!();
}
}
#[test]
fn test_uri_parsing() {
use crate::GString;
assert_eq!(
crate::uri_parse_scheme("foo://bar"),
Some(GString::from("foo"))
);
assert_eq!(crate::uri_parse_scheme("foo"), None);
let escaped = crate::uri_escape_string("&foo", crate::NONE_STR, true);
assert_eq!(escaped, GString::from("%26foo"));
let unescaped = crate::uri_unescape_string(escaped.as_str(), crate::GStr::NONE);
assert_eq!(unescaped, Some(GString::from("&foo")));
assert_eq!(
crate::uri_unescape_segment(Some("/foo"), crate::NONE_STR, crate::NONE_STR),
Some(GString::from("/foo"))
);
assert_eq!(
crate::uri_unescape_segment(Some("/foo%"), crate::NONE_STR, crate::NONE_STR),
None
);
}
}