big ass refactor

Author: Quant1um

README.md

@@ -6,8 +6,6 @@ Smol low-level windowing abstraction with a focus on audio plugin development
 
 ## Goals
 
-- Small API surface
-    - `picoview` should be easy to use and provide only the essentials for window creation, event handling and OS abstraction.
 - Low compile times
     - `picoview` should compile fast and not bloat your compile times. Uses minimum amount of dependencies.
 - Complete OS abstraction

ROADMAP.md

@@ -19,7 +19,6 @@
 |  - `WindowClose`                                      | :ok:     | :ok:     | :ok:     | Low      |
 |  - `WindowFocus`                                      | :ok:     | :ok:     | :ok:     | Low      |
 |  - `WindowScale`                                      | :ok:     | :ok:     | :ok:[^1] | Medium   |
-|  - `WindowTheme`                                      | :x:      | :x:      | :ok:     | Low      |
 |  - `WindowMove`                                       | :ok:     | :x:      | :ok:     | Low      |
 |  - `WindowResize`                                     | :ok:     | :ok:     | :ok:     | High     |
 |  - `WindowFrame`                                      | :ok:     | :ok:     | :ok:     | High     |
@@ -30,7 +29,7 @@
 | Event loop wakeup                                     | :ok:     | :ok:     | :ok:     | High     |
 | Vertical blank synchronization                        | :ok:[^2] | :ok:     | :o:[^3]  | High     |
 | OpenGL context creation                               | :ok:     | :ok:     | :ok:     | High     |
-| Clipboard text get/set                                | :ok:     | :ok:     | :x:      | Medium   |
+| Clipboard text get/set                                | :ok:     | :ok:     | :ok:     | Medium   |
 | Pixel scaling abstraction                             | :ok:     | :x:      | :ok:     | High     |
 | Set position                                          | :ok:     | :x:      | :ok:     | Medium   |
 | Set size                                              | :ok:     | :ok:     | :ok:     | High     |
@@ -56,8 +55,4 @@
     - Crashes when closing any window (even transient).
 - Windows:
     - Some cursor icons are not supported, fallbacks used.
-    - `Event::WindowMove` reports wrong absolute position - better WindowMove api needed.
-- X11:
-    - No clipboard support yet (really hard to implement)
-    - `WindowWaker::wakeup` does not report an error if the window is closed.
-     
+    - `Event::WindowMove` reports wrong absolute position - better WindowMove api needed.

src/data.rs

@@ -264,8 +264,6 @@ pub enum Key {
 
 /// An event generated by the windowing system and delivered to the event
 /// handler.
-///
-/// The core type of `picoview`.
 #[derive(Debug)]
 #[non_exhaustive]
 pub enum Event<'a> {
@@ -311,10 +309,7 @@ pub enum Event<'a> {
         ///
         /// See [`Window::set_position`](`crate::Window::set_position`) for
         /// details on coordinate system.
-        relative: Point,
-
-        /// The new position of the window relative to the entire screen.
-        absolute: Point,
+        point: Point,
     },
 
     /// Frame event. You should redraw the window in response to this event.

src/opengl.rs

@@ -1,6 +1,8 @@
-use std::ffi::{CStr, c_void};
-
 use crate::{MakeCurrentError, SwapBuffersError};
+use std::{
+    ffi::{CStr, c_void},
+    fmt,
+};
 
 /// A requested OpenGL version
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
@@ -96,17 +98,27 @@ impl Default for GlConfig {
 }
 
 /// OpenGL context belonging to a window
-pub trait GlContext {
-    /// Get the address of an OpenGL function
-    fn get_proc_address(&self, name: &CStr) -> *const c_void;
-
-    /// Make the OpenGL context active or inactive on the current thread
-    /// Returns true on success
-    ///
-    /// All OpenGL calls must be made only when the context is active for the
-    /// current thread
-    fn make_current(&self, current: bool) -> Result<(), MakeCurrentError>;
-
-    /// Swap the front and back buffers
-    fn swap_buffers(&self) -> Result<(), SwapBuffersError>;
+pub struct GlContext<'a>(pub(crate) crate::Window<'a>);
+
+impl<'a> GlContext<'a> {
+    /// Make this OpenGL context current or not current
+    pub fn make_current(&self, current: bool) -> Result<(), MakeCurrentError> {
+        self.0.0.opengl_make_current(current)
+    }
+
+    /// Swap the front and back buffers if double buffering is enabled
+    pub fn swap_buffers(&self) -> Result<(), SwapBuffersError> {
+        self.0.0.opengl_swap_buffers()
+    }
+
+    /// Get the address of an OpenGL function by name
+    pub fn get_proc_address(&self, name: &CStr) -> *const c_void {
+        self.0.0.opengl_get_proc_address(name)
+    }
+}
+
+impl<'a> fmt::Debug for GlContext<'a> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.debug_tuple("GlContext").finish_non_exhaustive()
+    }
 }

src/platform/mod.rs

@@ -14,7 +14,10 @@ pub mod mac;
 #[cfg(target_os = "macos")]
 pub use mac::*;
 
-use crate::{GlContext, MouseCursor, Point, Size, WakeupError, WindowWaker, rwh_06};
+use crate::{
+    MakeCurrentError, MouseCursor, Point, Size, SwapBuffersError, WakeupError, WindowWaker, rwh_06,
+};
+use std::ffi::{CStr, c_void};
 
 #[derive(Clone, Copy)]
 pub enum OpenMode {
@@ -40,7 +43,6 @@ pub trait PlatformWindow /* : !Send + !Sync */ {
 
     fn close(&self);
     fn waker(&self) -> WindowWaker;
-    fn opengl(&self) -> Option<&dyn GlContext>;
 
     fn set_title(&self, title: &str);
     fn set_cursor_icon(&self, icon: MouseCursor);
@@ -53,6 +55,11 @@ pub trait PlatformWindow /* : !Send + !Sync */ {
 
     fn get_clipboard_text(&self) -> Option<String>;
     fn set_clipboard_text(&self, text: &str) -> bool;
+
+    fn is_opengl_supported(&self) -> bool;
+    fn opengl_swap_buffers(&self) -> Result<(), SwapBuffersError>;
+    fn opengl_make_current(&self, current: bool) -> Result<(), MakeCurrentError>;
+    fn opengl_get_proc_address(&self, name: &CStr) -> *const c_void;
 }
 
 pub trait PlatformWaker: Send + Sync + 'static {

src/platform/x11/connection.rs

@@ -1,13 +1,12 @@
 use crate::WindowError;
-use libc::c_ulong;
 use raw_window_handle::XlibDisplayHandle;
 use std::{
     cell::RefCell,
     collections::HashMap,
     ffi::CStr,
     marker::PhantomData,
     mem::zeroed,
-    os::raw::c_int,
+    os::raw::{c_char, c_int, c_ulong},
     ptr::{NonNull, null, null_mut},
     str::FromStr,
     sync::{LazyLock, Mutex},
@@ -28,8 +27,6 @@ use x11::{
     },
 };
 
-pub const ATOM_PICOVIEW_WAKEUP: &CStr = c"PICOVIEW_WAKEUP";
-
 unsafe impl Send for Connection {}
 pub struct Connection {
     display: *mut Display,
@@ -39,7 +36,7 @@ pub struct Connection {
     cursor_cache: RefCell<HashMap<usize, c_ulong>>,
     atom_cache: RefCell<HashMap<usize, c_ulong>>,
 
-    unsync: PhantomData<*mut ()>,
+    not_sync: PhantomData<*mut ()>,
 }
 
 impl Connection {
@@ -51,7 +48,6 @@ impl Connection {
             }
 
             XSetErrorHandler(Some(error_handler));
-            XInternAtom(display, ATOM_PICOVIEW_WAKEUP.as_ptr() as _, 1);
 
             let screen = XDefaultScreen(display);
             let connection = Self {
@@ -62,7 +58,7 @@ impl Connection {
                 cursor_cache: RefCell::new(HashMap::new()),
                 atom_cache: RefCell::new(HashMap::new()),
 
-                unsync: PhantomData,
+                not_sync: PhantomData,
             };
 
             ERRORS_FOR_EACH_DISPLAY
@@ -74,7 +70,7 @@ impl Connection {
         }
     }
 
-    pub fn check_error(&self) -> Result<(), String> {
+    pub fn last_error(&self) -> Result<(), String> {
         let err = ERRORS_FOR_EACH_DISPLAY
             .lock()
             .expect("poisoned")
@@ -240,7 +236,7 @@ impl Connection {
             let mut event = XEvent { type_: 0 };
             if XNextEvent(self.display, &mut event) != 0 {
                 return Err(WindowError::Platform(
-                    self.check_error()
+                    self.last_error()
                         .err()
                         .unwrap_or_else(|| "unknown error".to_owned()),
                 ));
@@ -309,19 +305,15 @@ unsafe extern "C" fn error_handler(dpy: *mut Display, err: *mut XErrorEvent) ->
     }
 
     unsafe {
-        let mut buf = [0; 255];
+        let mut buf = [0 as c_char; 255];
         XGetErrorText(
             (*err).display,
             (*err).error_code.into(),
-            buf.as_mut_ptr().cast(),
+            buf.as_mut_ptr(),
             (buf.len() - 1) as i32,
         );
         buf[254] = 0;
-        conn.replace(
-            CStr::from_ptr(buf.as_mut_ptr().cast())
-                .to_string_lossy()
-                .into(),
-        );
+        conn.replace(CStr::from_ptr(buf.as_mut_ptr()).to_string_lossy().into());
     }
 
     0

src/platform/x11/gl.rs

@@ -53,7 +53,7 @@ impl GlContext {
                 HashSet::new()
             };
 
-            connection.check_error().map_err(WindowError::OpenGl)?;
+            connection.last_error().map_err(WindowError::OpenGl)?;
             Ok((major as u8, minor as u8, extensions))
         }
     }
@@ -254,7 +254,7 @@ impl GlContext {
             }
 
             XSync(connection.display(), 0);
-            connection.check_error().map_err(WindowError::OpenGl)?;
+            connection.last_error().map_err(WindowError::OpenGl)?;
 
             Ok(GlContext { window, context })
         }
@@ -275,23 +275,23 @@ impl GlContext {
     }
 }
 
-impl<'a> crate::GlContext for GlContextScope<'a> {
-    fn get_proc_address(&self, symbol: &CStr) -> *const c_void {
+impl GlContextScope<'_> {
+    pub fn get_proc_address(&self, symbol: &CStr) -> *const c_void {
         unsafe {
             glXGetProcAddress(symbol.as_ptr() as *const u8)
                 .map(|x| x as *const c_void)
                 .unwrap_or(null())
         }
     }
 
-    fn swap_buffers(&self) -> Result<(), SwapBuffersError> {
+    pub fn swap_buffers(&self) -> Result<(), SwapBuffersError> {
         unsafe {
             glXSwapBuffers(self.connection.display(), self.context.window);
             Ok(())
         }
     }
 
-    fn make_current(&self, current: bool) -> Result<(), MakeCurrentError> {
+    pub fn make_current(&self, current: bool) -> Result<(), MakeCurrentError> {
         unsafe {
             let result = {
                 if current {

src/platform/x11/util.rs

@@ -242,7 +242,7 @@ pub fn query_cursor(conn: &Connection, cursor: MouseCursor) -> c_ulong {
     }
 }
 
-pub fn get_position_relative(
+pub fn relative_position(
     conn: &Connection,
     window_parent: c_ulong,
     window_id: c_ulong,