glib/functions.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
// Take a look at the license at the top of the repository in the LICENSE file.
pub use crate::auto::functions::*;
#[cfg(not(windows))]
use std::boxed::Box as Box_;
#[cfg(not(windows))]
use std::mem;
#[cfg(not(windows))]
#[cfg(feature = "v2_58")]
use std::os::unix::io::AsRawFd;
#[cfg(not(windows))]
use std::os::unix::io::{FromRawFd, IntoRawFd, RawFd};
use std::ptr;
// #[cfg(windows)]
// #[cfg(feature = "v2_58")]
// use std::os::windows::io::AsRawHandle;
use crate::{ffi, translate::*, ChecksumType, GStr};
#[cfg(not(windows))]
use crate::{Error, Pid, SpawnFlags};
#[cfg(feature = "v2_58")]
#[cfg(not(windows))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "v2_58", not(windows)))))]
#[allow(clippy::too_many_arguments)]
#[doc(alias = "g_spawn_async_with_fds")]
pub fn spawn_async_with_fds<P: AsRef<std::path::Path>, T: AsRawFd, U: AsRawFd, V: AsRawFd>(
working_directory: P,
argv: &[&str],
envp: &[&str],
flags: SpawnFlags,
child_setup: Option<Box_<dyn FnOnce() + 'static>>,
stdin_fd: T,
stdout_fd: U,
stderr_fd: V,
) -> Result<Pid, Error> {
let child_setup_data: Box_<Option<Box_<dyn FnOnce() + 'static>>> = Box_::new(child_setup);
unsafe extern "C" fn child_setup_func(user_data: ffi::gpointer) {
let callback: Box_<Option<Box_<dyn FnOnce() + 'static>>> =
Box_::from_raw(user_data as *mut _);
let callback = (*callback).expect("cannot get closure...");
callback()
}
let child_setup = if child_setup_data.is_some() {
Some(child_setup_func as _)
} else {
None
};
let super_callback0: Box_<Option<Box_<dyn FnOnce() + 'static>>> = child_setup_data;
unsafe {
let mut child_pid = mem::MaybeUninit::uninit();
let mut error = ptr::null_mut();
let _ = ffi::g_spawn_async_with_fds(
working_directory.as_ref().to_glib_none().0,
argv.to_glib_none().0,
envp.to_glib_none().0,
flags.into_glib(),
child_setup,
Box_::into_raw(super_callback0) as *mut _,
child_pid.as_mut_ptr(),
stdin_fd.as_raw_fd(),
stdout_fd.as_raw_fd(),
stderr_fd.as_raw_fd(),
&mut error,
);
let child_pid = from_glib(child_pid.assume_init());
if error.is_null() {
Ok(child_pid)
} else {
Err(from_glib_full(error))
}
}
}
// #[cfg(feature = "v2_58")]
// #[cfg(windows)]
// pub fn spawn_async_with_fds<
// P: AsRef<std::path::Path>,
// T: AsRawHandle,
// U: AsRawHandle,
// V: AsRawHandle,
// >(
// working_directory: P,
// argv: &[&str],
// envp: &[&str],
// flags: SpawnFlags,
// child_setup: Option<Box_<dyn FnOnce() + 'static>>,
// stdin_fd: T,
// stdout_fd: U,
// stderr_fd: V,
// ) -> Result<Pid, Error> {
// let child_setup_data: Box_<Option<Box_<dyn FnOnce() + 'static>>> = Box_::new(child_setup);
// unsafe extern "C" fn child_setup_func<P: AsRef<std::path::Path>>(
// user_data: ffi::gpointer,
// ) {
// let callback: Box_<Option<Box_<dyn FnOnce() + 'static>>> =
// Box_::from_raw(user_data as *mut _);
// let callback = (*callback).expect("cannot get closure...");
// callback()
// }
// let child_setup = if child_setup_data.is_some() {
// Some(child_setup_func::<P> as _)
// } else {
// None
// };
// let super_callback0: Box_<Option<Box_<dyn FnOnce() + 'static>>> = child_setup_data;
// unsafe {
// let mut child_pid = mem::MaybeUninit::uninit();
// let mut error = ptr::null_mut();
// let _ = ffi::g_spawn_async_with_fds(
// working_directory.as_ref().to_glib_none().0,
// argv.to_glib_none().0,
// envp.to_glib_none().0,
// flags.into_glib(),
// child_setup,
// Box_::into_raw(super_callback0) as *mut _,
// child_pid.as_mut_ptr(),
// stdin_fd.as_raw_handle() as usize as _,
// stdout_fd.as_raw_handle() as usize as _,
// stderr_fd.as_raw_handle() as usize as _,
// &mut error,
// );
// let child_pid = from_glib(child_pid.assume_init());
// if error.is_null() {
// Ok(child_pid)
// } else {
// Err(from_glib_full(error))
// }
// }
// }
#[cfg(not(windows))]
#[cfg_attr(docsrs, doc(cfg(not(windows))))]
#[doc(alias = "g_spawn_async_with_pipes")]
pub fn spawn_async_with_pipes<
P: AsRef<std::path::Path>,
T: FromRawFd,
U: FromRawFd,
V: FromRawFd,
>(
working_directory: P,
argv: &[&std::path::Path],
envp: &[&std::path::Path],
flags: SpawnFlags,
child_setup: Option<Box_<dyn FnOnce() + 'static>>,
) -> Result<(Pid, T, U, V), Error> {
let child_setup_data: Box_<Option<Box_<dyn FnOnce() + 'static>>> = Box_::new(child_setup);
unsafe extern "C" fn child_setup_func(user_data: ffi::gpointer) {
let callback: Box_<Option<Box_<dyn FnOnce() + 'static>>> =
Box_::from_raw(user_data as *mut _);
let callback = (*callback).expect("cannot get closure...");
callback()
}
let child_setup = if child_setup_data.is_some() {
Some(child_setup_func as _)
} else {
None
};
let super_callback0: Box_<Option<Box_<dyn FnOnce() + 'static>>> = child_setup_data;
unsafe {
let mut child_pid = mem::MaybeUninit::uninit();
let mut standard_input = mem::MaybeUninit::uninit();
let mut standard_output = mem::MaybeUninit::uninit();
let mut standard_error = mem::MaybeUninit::uninit();
let mut error = ptr::null_mut();
let _ = ffi::g_spawn_async_with_pipes(
working_directory.as_ref().to_glib_none().0,
argv.to_glib_none().0,
envp.to_glib_none().0,
flags.into_glib(),
child_setup,
Box_::into_raw(super_callback0) as *mut _,
child_pid.as_mut_ptr(),
standard_input.as_mut_ptr(),
standard_output.as_mut_ptr(),
standard_error.as_mut_ptr(),
&mut error,
);
let child_pid = from_glib(child_pid.assume_init());
let standard_input = standard_input.assume_init();
let standard_output = standard_output.assume_init();
let standard_error = standard_error.assume_init();
if error.is_null() {
#[cfg(not(windows))]
{
Ok((
child_pid,
FromRawFd::from_raw_fd(standard_input),
FromRawFd::from_raw_fd(standard_output),
FromRawFd::from_raw_fd(standard_error),
))
}
// #[cfg(windows)]
// {
// use std::os::windows::io::{FromRawHandle, RawHandle};
// Ok((
// child_pid,
// File::from_raw_handle(standard_input as usize as RawHandle),
// File::from_raw_handle(standard_output as usize as RawHandle),
// File::from_raw_handle(standard_error as usize as RawHandle),
// ))
// }
} else {
Err(from_glib_full(error))
}
}
}
// rustdoc-stripper-ignore-next
/// Obtain the character set for the current locale.
///
/// This returns whether the locale's encoding is UTF-8, and the current
/// charset if available.
#[doc(alias = "g_get_charset")]
#[doc(alias = "get_charset")]
pub fn charset() -> (bool, Option<&'static GStr>) {
unsafe {
let mut out_charset = ptr::null();
let is_utf8 = from_glib(ffi::g_get_charset(&mut out_charset));
let charset = from_glib_none(out_charset);
(is_utf8, charset)
}
}
#[doc(alias = "g_compute_checksum_for_string")]
pub fn compute_checksum_for_string(
checksum_type: ChecksumType,
str: impl IntoGStr,
) -> Option<crate::GString> {
str.run_with_gstr(|str| unsafe {
from_glib_full(ffi::g_compute_checksum_for_string(
checksum_type.into_glib(),
str.as_ptr(),
str.len() as _,
))
})
}
/// Similar to the UNIX pipe() call, but on modern systems like Linux
/// uses the pipe2() system call, which atomically creates a pipe with
/// the configured flags.
///
/// As of GLib 2.78, the supported flags are `O_CLOEXEC`/`FD_CLOEXEC` (see below)
/// and `O_NONBLOCK`. Prior to GLib 2.78, only `FD_CLOEXEC` was supported — if
/// you wanted to configure `O_NONBLOCK` then that had to be done separately with
/// `fcntl()`.
///
/// Since GLib 2.80, the constants `G_UNIX_PIPE_END_READ` and
/// `G_UNIX_PIPE_END_WRITE` can be used as mnemonic indexes in @fds.
///
/// It is a programmer error to call this function with unsupported flags, and a
/// critical warning will be raised.
///
/// As of GLib 2.78, it is preferred to pass `O_CLOEXEC` in, rather than
/// `FD_CLOEXEC`, as that matches the underlying `pipe()` API more closely. Prior
/// to 2.78, only `FD_CLOEXEC` was supported. Support for `FD_CLOEXEC` may be
/// deprecated and removed in future.
/// ## `fds`
/// Array of two integers
/// ## `flags`
/// Bitfield of file descriptor flags, as for fcntl()
///
/// # Returns
///
/// [`true`] on success, [`false`] if not (and errno will be set).
#[cfg(unix)]
#[doc(alias = "g_unix_open_pipe")]
pub fn unix_open_pipe(flags: i32) -> Result<(RawFd, RawFd), Error> {
unsafe {
let mut fds = [0, 2];
let mut error = ptr::null_mut();
let _ = ffi::g_unix_open_pipe(&mut fds, flags, &mut error);
if error.is_null() {
Ok((
FromRawFd::from_raw_fd(fds[0]),
FromRawFd::from_raw_fd(fds[1]),
))
} else {
Err(from_glib_full(error))
}
}
}
/// Opens a file for writing in the preferred directory for temporary
/// files (as returned by g_get_tmp_dir()).
///
/// @tmpl should be a string in the GLib file name encoding containing
/// a sequence of six 'X' characters, as the parameter to g_mkstemp().
/// However, unlike these functions, the template should only be a
/// basename, no directory components are allowed. If template is
/// [`None`], a default template is used.
///
/// Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not
/// modified, and might thus be a read-only literal string.
///
/// Upon success, and if @name_used is non-[`None`], the actual name used
/// is returned in @name_used. This string should be freed with g_free()
/// when not needed any longer. The returned name is in the GLib file
/// name encoding.
/// ## `tmpl`
/// Template for file name, as in
/// g_mkstemp(), basename only, or [`None`] for a default template
///
/// # 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 @error will be set.
///
/// ## `name_used`
/// location to store actual name used,
/// or [`None`]
// rustdoc-stripper-ignore-next-stop
/// Opens a file for writing in the preferred directory for temporary
/// files (as returned by g_get_tmp_dir()).
///
/// @tmpl should be a string in the GLib file name encoding containing
/// a sequence of six 'X' characters, as the parameter to g_mkstemp().
/// However, unlike these functions, the template should only be a
/// basename, no directory components are allowed. If template is
/// [`None`], a default template is used.
///
/// Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not
/// modified, and might thus be a read-only literal string.
///
/// Upon success, and if @name_used is non-[`None`], the actual name used
/// is returned in @name_used. This string should be freed with g_free()
/// when not needed any longer. The returned name is in the GLib file
/// name encoding.
/// ## `tmpl`
/// Template for file name, as in
/// g_mkstemp(), basename only, or [`None`] for a default template
///
/// # 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 @error will be set.
///
/// ## `name_used`
/// location to store actual name used,
/// or [`None`]
#[cfg(unix)]
#[doc(alias = "g_file_open_tmp")]
pub fn file_open_tmp(
tmpl: Option<impl AsRef<std::path::Path>>,
) -> Result<(RawFd, std::path::PathBuf), crate::Error> {
unsafe {
let mut name_used = ptr::null_mut();
let mut error = ptr::null_mut();
let ret = ffi::g_file_open_tmp(
tmpl.as_ref().map(|p| p.as_ref()).to_glib_none().0,
&mut name_used,
&mut error,
);
if error.is_null() {
Ok((ret.into_raw_fd(), from_glib_full(name_used)))
} else {
Err(from_glib_full(error))
}
}
}
// rustdoc-stripper-ignore-next
/// Spawn a new infallible `Future` on the thread-default main context.
///
/// This can be called from any thread and will execute the future from the thread
/// where main context is running, e.g. via a `MainLoop`.
pub fn spawn_future<R: Send + 'static, F: std::future::Future<Output = R> + Send + 'static>(
f: F,
) -> crate::JoinHandle<R> {
let ctx = crate::MainContext::ref_thread_default();
ctx.spawn(f)
}
// rustdoc-stripper-ignore-next
/// Spawn a new infallible `Future` on the thread-default main context.
///
/// The given `Future` does not have to be `Send`.
///
/// This can be called only from the thread where the main context is running, e.g.
/// from any other `Future` that is executed on this main context, or after calling
/// `with_thread_default` or `acquire` on the main context.
pub fn spawn_future_local<R: 'static, F: std::future::Future<Output = R> + 'static>(
f: F,
) -> crate::JoinHandle<R> {
let ctx = crate::MainContext::ref_thread_default();
ctx.spawn_local(f)
}