gdk4-x11: create type aliases for XID/XWindow/XCursor

bilelmoussaoui · bilelmoussaoui · commit 09df14f23e57 · 2021-12-12T14:58:09.000+01:00
if the xlib feature is not used, instead of completely ignoring those functions
that returns a XID (which is an alias of ulong)
let's provide an alias ourselves in that case and hide it in case the xlib feature is enabled.

This should help people using gdk4-x11 use more features without pulling the x11 crate
that doesn't add any useful features as is other than wrapping pointers.
diff --git a/gdk4-x11/src/functions.rs b/gdk4-x11/src/functions.rs
@@ -1,19 +1,16 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
 use crate::X11Display;
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
 use glib::translate::*;
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
-use x11::xlib;
 
+#[cfg(not(feature = "xlib"))]
+use crate::XAtom;
 #[cfg(any(feature = "xlib", feature = "dox"))]
 #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
+use x11::xlib::Atom as XAtom;
+
 #[doc(alias = "gdk_x11_get_xatom_by_name_for_display")]
-pub fn x11_get_xatom_by_name_for_display(display: &X11Display, atom_name: &str) -> xlib::Atom {
+pub fn x11_get_xatom_by_name_for_display(display: &X11Display, atom_name: &str) -> XAtom {
     skip_assert_initialized!();
     unsafe {
         ffi::gdk_x11_get_xatom_by_name_for_display(
@@ -23,13 +20,8 @@ pub fn x11_get_xatom_by_name_for_display(display: &X11Display, atom_name: &str)
     }
 }
 
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
 #[doc(alias = "gdk_x11_get_xatom_name_for_display")]
-pub fn x11_get_xatom_name_for_display(
-    display: &X11Display,
-    xatom: xlib::Atom,
-) -> Option<glib::GString> {
+pub fn x11_get_xatom_name_for_display(display: &X11Display, xatom: XAtom) -> Option<glib::GString> {
     skip_assert_initialized!();
     unsafe {
         from_glib_none(ffi::gdk_x11_get_xatom_name_for_display(
diff --git a/gdk4-x11/src/lib.rs b/gdk4-x11/src/lib.rs
@@ -32,3 +32,12 @@ mod x11_surface;
 pub use auto::functions::*;
 pub use auto::*;
 pub use functions::*;
+
+#[cfg(not(feature = "xlib"))]
+pub type XID = libc::c_ulong;
+#[cfg(not(feature = "xlib"))]
+pub type XWindow = XID;
+#[cfg(not(feature = "xlib"))]
+pub type XCursor = XID;
+#[cfg(not(feature = "xlib"))]
+pub type XAtom = XID;
diff --git a/gdk4-x11/src/x11_display.rs b/gdk4-x11/src/x11_display.rs
@@ -3,7 +3,7 @@
 use crate::X11Display;
 #[cfg(any(feature = "xlib", feature = "dox"))]
 #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
-use glib::{signal::connect_raw, signal::SignalHandlerId, translate::*, ObjectType};
+use glib::{signal::connect_raw, signal::SignalHandlerId, ObjectType};
 #[cfg(any(all(feature = "v4_4", feature = "egl"), feature = "dox"))]
 #[cfg_attr(feature = "dox", doc(cfg(all(feature = "v4_4", feature = "egl"))))]
 use khronos_egl as egl;
@@ -17,6 +17,13 @@ use std::mem::transmute;
 #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
 use x11::xlib;
 
+#[cfg(not(feature = "xlib"))]
+use crate::{XCursor, XWindow};
+use glib::translate::*;
+#[cfg(any(feature = "xlib", feature = "dox"))]
+#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
+use x11::xlib::{Cursor as XCursor, Window as XWindow};
+
 impl X11Display {
     #[cfg(any(all(feature = "v4_4", feature = "egl"), feature = "dox"))]
     #[cfg_attr(feature = "dox", doc(cfg(all(feature = "v4_4", feature = "egl"))))]
@@ -33,19 +40,15 @@ impl X11Display {
         }
     }
 
-    #[cfg(any(feature = "xlib", feature = "dox"))]
-    #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
     #[doc(alias = "gdk_x11_display_get_xcursor")]
     #[doc(alias = "get_xcursor")]
-    pub fn xcursor(&self, cursor: &gdk::Cursor) -> xlib::Cursor {
+    pub fn xcursor(&self, cursor: &gdk::Cursor) -> XCursor {
         unsafe { ffi::gdk_x11_display_get_xcursor(self.to_glib_none().0, cursor.to_glib_none().0) }
     }
 
-    #[cfg(any(feature = "xlib", feature = "dox"))]
-    #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
     #[doc(alias = "gdk_x11_display_get_xrootwindow")]
     #[doc(alias = "get_xrootwindow")]
-    pub fn xrootwindow(&self) -> xlib::Window {
+    pub fn xrootwindow(&self) -> XWindow {
         unsafe { ffi::gdk_x11_display_get_xrootwindow(self.to_glib_none().0) }
     }
 
diff --git a/gdk4-x11/src/x11_monitor.rs b/gdk4-x11/src/x11_monitor.rs
@@ -1,19 +1,17 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 use crate::X11Monitor;
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
+#[cfg(not(feature = "xlib"))]
+use crate::XID;
 use glib::translate::*;
 #[cfg(any(feature = "xlib", feature = "dox"))]
 #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
-use x11::xlib;
+use x11::xlib::XID;
 
 impl X11Monitor {
-    #[cfg(any(feature = "xlib", feature = "dox"))]
-    #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
     #[doc(alias = "gdk_x11_monitor_get_output")]
     #[doc(alias = "get_output")]
-    pub fn output(&self) -> xlib::XID {
+    pub fn output(&self) -> XID {
         unsafe { ffi::gdk_x11_monitor_get_output(self.to_glib_none().0) }
     }
 }
diff --git a/gdk4-x11/src/x11_screen.rs b/gdk4-x11/src/x11_screen.rs
@@ -1,12 +1,12 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 use crate::X11Screen;
+#[cfg(not(feature = "xlib"))]
+use crate::XID;
+use glib::translate::*;
 #[cfg(any(feature = "xlib", feature = "dox"))]
 #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
-use glib::translate::ToGlibPtr;
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
-use x11::xlib;
+use x11::xlib::{self, XID};
 
 impl X11Screen {
     #[cfg(any(feature = "xlib", feature = "dox"))]
@@ -17,11 +17,9 @@ impl X11Screen {
         ffi::gdk_x11_screen_get_xscreen(self.to_glib_none().0) as *mut xlib::Screen
     }
 
-    #[cfg(any(feature = "xlib", feature = "dox"))]
-    #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
     #[doc(alias = "gdk_x11_screen_get_monitor_output")]
     #[doc(alias = "get_monitor_output")]
-    pub fn monitor_output(&self, monitor_num: i32) -> xlib::XID {
+    pub fn monitor_output(&self, monitor_num: i32) -> XID {
         unsafe { ffi::gdk_x11_screen_get_monitor_output(self.to_glib_none().0, monitor_num) }
     }
 }
diff --git a/gdk4-x11/src/x11_surface.rs b/gdk4-x11/src/x11_surface.rs
@@ -1,29 +1,22 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 use crate::X11Surface;
-#[cfg(any(feature = "xlib", feature = "dox"))]
-#[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
+#[cfg(not(feature = "xlib"))]
+use crate::XWindow;
 use glib::translate::*;
 #[cfg(any(feature = "xlib", feature = "dox"))]
 #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
-use x11::xlib;
+use x11::xlib::Window as XWindow;
 
 impl X11Surface {
-    #[cfg(any(feature = "xlib", feature = "dox"))]
-    #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
     #[doc(alias = "gdk_x11_surface_get_xid")]
     #[doc(alias = "get_xid")]
-    pub fn xid(&self) -> xlib::Window {
+    pub fn xid(&self) -> XWindow {
         unsafe { ffi::gdk_x11_surface_get_xid(self.to_glib_none().0) }
     }
 
-    #[cfg(any(feature = "xlib", feature = "dox"))]
-    #[cfg_attr(feature = "dox", doc(cfg(feature = "xlib")))]
     #[doc(alias = "gdk_x11_surface_lookup_for_display")]
-    pub fn lookup_for_display(
-        display: &crate::X11Display,
-        window: xlib::Window,
-    ) -> Option<X11Surface> {
+    pub fn lookup_for_display(display: &crate::X11Display, window: XWindow) -> Option<X11Surface> {
         skip_assert_initialized!();
         unsafe {
             from_glib_none(ffi::gdk_x11_surface_lookup_for_display(
