sdl3/
clipboard.rs

1use crate::get_error;
2use crate::Error;
3use libc::c_char;
4use libc::c_void;
5use std::ffi::{CStr, CString};
6
7use crate::sys;
8
9/// Clipboard utility functions. Access with `VideoSubsystem::clipboard()`.
10///
11/// These functions require the video subsystem to be initialized.
12///
13/// ```no_run
14/// let sdl_context = sdl3::init().unwrap();
15/// let video_subsystem = sdl_context.video().unwrap();
16///
17/// video_subsystem.clipboard().set_clipboard_text("Hello World!").unwrap();
18/// ```
19pub struct ClipboardUtil {
20    _subsystem: crate::VideoSubsystem,
21}
22
23impl crate::VideoSubsystem {
24    #[inline]
25    pub fn clipboard(&self) -> ClipboardUtil {
26        ClipboardUtil {
27            _subsystem: self.clone(),
28        }
29    }
30}
31
32impl ClipboardUtil {
33    #[doc(alias = "SDL_SetClipboardText")]
34    pub fn set_clipboard_text(&self, text: &str) -> Result<(), Error> {
35        unsafe {
36            let text = CString::new(text).unwrap();
37            let result = sys::clipboard::SDL_SetClipboardText(text.as_ptr() as *const c_char);
38
39            if result {
40                Err(get_error())
41            } else {
42                Ok(())
43            }
44        }
45    }
46
47    #[doc(alias = "SDL_GetClipboardText")]
48    pub fn clipboard_text(&self) -> Result<String, Error> {
49        unsafe {
50            let buf = sys::clipboard::SDL_GetClipboardText();
51
52            if buf.is_null() {
53                Err(get_error())
54            } else {
55                let s = CStr::from_ptr(buf as *const _).to_str().unwrap().to_owned();
56                sys::stdinc::SDL_free(buf as *mut c_void);
57                Ok(s)
58            }
59        }
60    }
61
62    #[doc(alias = "SDL_HasClipboardText")]
63    pub fn has_clipboard_text(&self) -> bool {
64        unsafe { sys::clipboard::SDL_HasClipboardText() }
65    }
66}