Unfinished Wayland PR (#1)

moved from the github repo.

current progress:

<img width="389" alt="image.png" src="attachments/6a2cb365-7348-44b4-8fa7-9980df965a67">

Other notes:

- took the opportunity to remove MwLLSetBackground which I was told was deprecated
- Updated .gitignore to more accurately cover/remove example binaries
- Uses OpenGL as the backend.
- New LL function for swapping buffers, MwLLEndDraw
- [TODO] Uses weak linking for all libraries so that systems that don't support Wayland or even have it installed can launch without it.

Reviewed-on: https://gitea.nishi.boats/pyrite-dev/milsko/pulls/1
Co-authored-by: IoIxD <alphaproject217@gmail.com>
Co-committed-by: IoIxD <alphaproject217@gmail.com>

include/Mw/LowLevel.h

@@ -25,7 +25,8 @@ typedef void* MwLLPixmap;
 
 enum MwLLBackends {
 	MwLLBackendX11 = 0,
-	MwLLBackendGDI
+	MwLLBackendGDI,
+	MwLLBackendWayland,
 };
 
 struct _MwLLCommon {
@@ -55,6 +56,9 @@ struct _MwLLCommonPixmap {
 #ifdef USE_GDI
 #include <Mw/LowLevel/GDI.h>
 #endif
+#ifdef USE_WAYLAND
+#include <Mw/LowLevel/Wayland.h>
+#endif
 
 union _MwLL {
 	struct _MwLLCommon common;
@@ -64,6 +68,9 @@ union _MwLL {
 #ifdef USE_GDI
 	struct _MwLLGDI gdi;
 #endif
+#ifdef USE_WAYLAND
+	struct _MwLLWayland wayland;
+#endif
 };
 
 union _MwLLColor {
@@ -74,6 +81,9 @@ union _MwLLColor {
 #ifdef USE_GDI
 	struct _MwLLGDIColor gdi;
 #endif
+#ifdef USE_WAYLAND
+	struct _MwLLWaylandColor wayland;
+#endif
 };
 
 union _MwLLPixmap {
@@ -84,6 +94,9 @@ union _MwLLPixmap {
 #ifdef USE_GDI
 	struct _MwLLGDIPixmap gdi;
 #endif
+#ifdef USE_WAYLAND
+	struct _MwLLWaylandPixmap wayland;
+#endif
 };
 #endif
 #include <Mw/TypeDefs.h>
@@ -149,6 +162,8 @@ MWDECL void (*MwLLDestroy)(MwLL handle);
 
 MWDECL void (*MwLLPolygon)(MwLL handle, MwPoint* points, int points_count, MwLLColor color);
 MWDECL void (*MwLLLine)(MwLL handle, MwPoint* points, MwLLColor color);
+MWDECL void (*MwLLBeginDraw)(MwLL handle);
+MWDECL void (*MwLLEndDraw)(MwLL handle);
 
 MWDECL MwLLColor (*MwLLAllocColor)(MwLL handle, int r, int g, int b);
 MWDECL void (*MwLLColorUpdate)(MwLL handle, MwLLColor c, int r, int g, int b);

include/Mw/LowLevel/Wayland.h

@@ -0,0 +1,121 @@
+/*!
+ * @file Mw/LowLevel/Wayland.h
+ * @brief Work in progress Wayland Backend
+ * @warning This is used internally.
+ * @warning This is disabled by default.
+ */
+#ifndef __MW_LOWLEVEL_WAYLAND_H__
+#define __MW_LOWLEVEL_WAYLAND_H__
+
+#include <Mw/MachDep.h>
+#include <Mw/TypeDefs.h>
+#include <Mw/LowLevel.h>
+
+#include <wayland-client-protocol.h>
+#include <wayland-egl.h>
+#include <EGL/egl.h>
+#include <GL/gl.h>
+#include <GL/glext.h>
+
+#include <wayland-client.h>
+#include <xkbcommon/xkbcommon.h>
+
+MWDECL int MwLLWaylandCallInit(void);
+
+#ifndef WL_PROTOCOLS_DEFINED
+#define WL_PROTOCOLS_DEFINED
+#include "Wayland/xdg-shell-client-protocol.h"
+#include "Wayland/xdg-decoration-client-protocol.h"
+#include "Wayland/cursor-shape-client-protocol.h"
+#endif
+
+struct _MwLLWayland;
+
+typedef struct wayland_protocol {
+	void* listener;
+	void* context;
+} wayland_protocol_t;
+
+typedef wayland_protocol_t*(wl_setup_func)(MwU32, struct _MwLLWayland*);
+
+struct _MwLLWaylandTopLevel {
+	struct xdg_surface*	     xdg_surface;
+	struct xdg_toplevel*	     xdg_top_level;
+	struct xdg_toplevel_listener xdg_toplevel_listener;
+	struct xdg_surface_listener  xdg_surface_listener;
+
+	struct xkb_context* xkb_context;
+	struct xkb_keymap*  xkb_keymap;
+	struct xkb_state*   xkb_state;
+
+	MwBool compositor_created;
+	MwBool xdg_wm_base_created;
+	MwBool xdg_surface_created;
+};
+
+struct _MwLLWayland {
+	struct _MwLLCommon common;
+
+	/* Pointer for data that's only loaded if the widget is a toplevel */
+	struct _MwLLWaylandTopLevel* toplevel;
+
+	enum {
+		MWLL_WAYLAND_TOPLEVEL = 0,
+		MWLL_WAYLAND_SUBLEVEL = 1, /* Sublevels are surfaces that have the toplevel as a parent. They could be implemented as subsurfaces if we ever switch away from OpenGL. Some parts of the code also call them subwidgets. */
+	} type;
+
+	/* Map of Wayland interfaces to their relevant setup functions. */
+	struct {
+		const char*    key;
+		wl_setup_func* value;
+	}* wl_protocol_setup_map;
+
+	/* Map of Wayland interfaces to any information we keep about them once we've registered them. */
+	struct {
+		const char*	    key;
+		wayland_protocol_t* value;
+	}* wl_protocol_map;
+
+	struct wl_display*	    display;
+	struct wl_registry*	    registry;
+	struct wl_compositor*	    compositor;
+	struct wl_subcompositor*    subcompositor;
+	struct wl_surface*	    surface;
+	struct wl_registry_listener registry_listener;
+	struct wl_event_queue*	    event_queue;
+
+	EGLNativeWindowType egl_window_native;
+	EGLDisplay	    egl_display;
+	EGLContext	    egl_context;
+	EGLSurface	    egl_surface;
+	EGLConfig	    egl_config;
+
+	MwLL*  sublevels;  /* stb_ds managed array of any sublevels */
+	MwBool configured; /* Whether or not xdg_toplevel_configure has run once */
+	MwBool egl_setup;  /* Whether or not EGL has been set up */
+	MwBool has_set_xy /* Whether or not MwSetXY has been called */;
+
+	int	resize_counter; /* Counter that's for a hack in event_loop */
+	MwU32	x, y, ww, wh;	/* Window position */
+	MwU32	lw, lh;		/* Last known window position */
+	MwPoint cur_mouse_pos;	/* Currently known mouse position */
+
+	struct timeval timer;
+	MwU64	       cooldown_timer;
+	MwU64	       cooldown_timer_epoch;
+
+	MwLL parent;
+	MwLL topmost_parent; /* The parent at the top of all the other parents. Usually a toplevel. */
+};
+
+struct _MwLLWaylandColor {
+	struct _MwLLCommonColor common;
+};
+
+struct _MwLLWaylandPixmap {
+	struct _MwLLCommonPixmap common;
+	GLuint			 texture;
+	MwBool			 texture_deleted;
+};
+
+#endif

include/Mw/LowLevel/Wayland/.gitignore

@@ -0,0 +1 @@
+*protocol.h

include/Mw/LowLevel/Wayland/README.md

@@ -0,0 +1 @@
+Folder for wayland-scanner to place any of its files.

include/Mw/MachDep.h

@@ -13,6 +13,7 @@
 #include <sys/types.h>
 #include <assert.h>
 #include <math.h>
+#include <errno.h>
 #include <ctype.h>
 #include <time.h>
 #include <sys/stat.h>
@@ -43,6 +44,7 @@
 #include <dlfcn.h>
 #include <signal.h>
 #include <dirent.h>
+#include <fcntl.h>
 #endif
 
 #ifndef M_PI

pl/rules.pl

@@ -26,6 +26,26 @@ if (grep(/^gdi$/, @backends)) {
     $gl_libs = "-lopengl32 -lglu32";
 }
 
+if (grep(/^wayland$/, @backends)) {
+    add_cflags("-DUSE_WAYLAND");
+    new_object("src/backend/wayland.c");
+    if ($cross) {
+        add_libs("-lGL -lEGL -lwayland-egl -lwayland-client -lxkbcommon");
+    }
+    else {
+        add_libs("-lGL -lEGL");
+        add_cflags(`pkg-config --cflags wayland-egl wayland-client xkbcommon`);
+        add_libs(`pkg-config --libs wayland-egl wayland-client xkbcommon`);
+    }
+
+    scan_wayland_protocol("stable",   "xdg-shell",      "");
+    scan_wayland_protocol("stable",   "tablet",         "-v2");
+    scan_wayland_protocol("staging",  "cursor-shape",   "-v1");
+    scan_wayland_protocol("unstable", "xdg-decoration", "-unstable-v1");
+
+    $gl_libs = "-lGL -lGLU";
+}
+
 if (param_get("stb-image")) {
     add_cflags("-DUSE_STB_IMAGE");
 }
@@ -34,7 +54,10 @@ if (param_get("stb-truetype")) {
 }
 if (param_get("freetype2")) {
     add_cflags("-DUSE_FREETYPE2");
-    if (not($cross)) {
+    if ($cross) {
+        add_libs("-lfreetype");
+    }
+    else {
         add_cflags(`pkg-config --cflags freetype2`);
         add_libs(`pkg-config --libs freetype2`);
     }

pl/utils.pl

@@ -54,6 +54,38 @@ sub use_backend {
     }
 }
 
+sub scan_wayland_protocol {
+    my $tier  = $_[0];
+    my $proto = $_[1];
+    my $ver   = $_[2];
+
+    my $proto_c = "src/backend/wayland-${proto}-protocol.c";
+
+    if (
+        system(
+"wayland-scanner private-code /usr/share/wayland-protocols/${tier}/${proto}/${proto}${ver}.xml ${proto_c}"
+        ) != 0
+      )
+    {
+        print(
+"^ Error on getting private code for /usr/share/wayland-protocols/${tier}/${proto}/${proto}${ver}.xml\n"
+        );
+    }
+    else {
+        new_object($proto_c);
+    }
+    if (
+        system(
+"wayland-scanner client-header /usr/share/wayland-protocols/${tier}/${proto}/${proto}${ver}.xml include/Mw/LowLevel/Wayland/${proto}-client-protocol.h"
+        )
+      )
+    {
+        print(
+"^ Error on getting client header for /usr/share/wayland-protocols/${tier}/${proto}/${proto}${ver}.xml\n"
+        );
+    }
+}
+
 our %params = ();
 
 sub param_set {

src/backend/.gitignore

@@ -0,0 +1 @@
+wayland*protocol.c

src/backend/call.c

@@ -10,6 +10,8 @@
 \
 		MwLLPolygon   = MwLLPolygonImpl; \
 		MwLLLine      = MwLLLineImpl; \
+		MwLLBeginDraw = MwLLBeginDrawImpl; \
+		MwLLEndDraw   = MwLLEndDrawImpl; \
 \
 		MwLLAllocColor	= MwLLAllocColorImpl; \
 		MwLLColorUpdate = MwLLColorUpdateImpl; \

src/backend/gdi.c

@@ -280,6 +280,14 @@ static void MwLLDestroyImpl(MwLL handle) {
 	free(handle);
 }
 
+static void MwLLBeginDrawImpl(MwLL handle) {
+	(void)handle;
+}
+
+static void MwLLEndDrawImpl(MwLL handle) {
+	(void)handle;
+}
+
 static void MwLLPolygonImpl(MwLL handle, MwPoint* points, int points_count, MwLLColor color) {
 	POINT* p   = malloc(sizeof(*p) * points_count);
 	HPEN   pen = CreatePen(PS_NULL, 0, RGB(0, 0, 0));

src/backend/x11.c

@@ -259,6 +259,14 @@ static void MwLLDestroyImpl(MwLL handle) {
 	free(handle);
 }
 
+static void MwLLBeginDrawImpl(MwLL handle) {
+	(void)handle;
+}
+
+static void MwLLEndDrawImpl(MwLL handle) {
+	(void)handle;
+}
+
 static void MwLLPolygonImpl(MwLL handle, MwPoint* points, int points_count, MwLLColor color) {
 	int	i;
 	XPoint* p = malloc(sizeof(*p) * points_count);
@@ -1028,7 +1036,6 @@ static void MwLLEndStateChangeImpl(MwLL handle) {
 }
 
 static int MwLLX11CallInitImpl(void) {
-	/* TODO: check properly */
 	return 0;
 }
 

src/core.c

@@ -1,16 +1,20 @@
 #include <Mw/Milsko.h>
 
 #include "../external/stb_ds.h"
+#include "Mw/LowLevel.h"
 
 static void lldrawhandler(MwLL handle, void* data) {
 	MwWidget h = (MwWidget)handle->common.user;
 
 	(void)data;
+	MwLLBeginDraw(handle);
 
 	h->bgcolor = NULL;
 	MwDispatch(h, draw);
 	if(h->draw_inject != NULL) h->draw_inject(h);
 	MwDispatchUserHandler(h, MwNdrawHandler, NULL);
+
+	MwLLEndDraw(handle);
 }
 
 static void lluphandler(MwLL handle, void* data) {
@@ -303,7 +307,10 @@ int MwStep(MwWidget handle) {
 	arrfree(widgets);
 
 	handle->prop_event = 0;
-	if(handle->lowlevel != NULL && MwLLPending(handle->lowlevel)) MwLLNextEvent(handle->lowlevel);
+
+	if(handle->lowlevel != NULL && MwLLPending(handle->lowlevel))
+		MwLLNextEvent(handle->lowlevel);
+
 	handle->prop_event = 1;
 
 	clean_destroy_queue(handle);
@@ -694,6 +701,9 @@ MwWidget MwGetParent(MwWidget handle) {
 typedef int (*call_t)(void);
 int MwLibraryInit(void) {
 	call_t calls[] = {
+#ifdef USE_WAYLAND
+	    MwLLWaylandCallInit,
+#endif
 #ifdef USE_X11
 	    MwLLX11CallInit,
 #endif

src/draw.c

@@ -491,6 +491,7 @@ void MwDrawTriangle(MwWidget handle, MwRect* rect, MwLLColor color, int invert,
 		p4[2].y = rect->y + s * border;
 	}
 	MwLLPolygon(handle->lowlevel, p4, 3, col);
+
 	if(color != col) MwLLFreeColor(col);
 
 	MwLLFreeColor(lighter);

src/lowlevel.c

@@ -6,6 +6,9 @@ void (*MwLLDestroy)(MwLL handle);
 void (*MwLLPolygon)(MwLL handle, MwPoint* points, int points_count, MwLLColor color);
 void (*MwLLLine)(MwLL handle, MwPoint* points, MwLLColor color);
 
+void (*MwLLBeginDraw)(MwLL handle);
+void (*MwLLEndDraw)(MwLL handle);
+
 MwLLColor (*MwLLAllocColor)(MwLL handle, int r, int g, int b);
 void (*MwLLColorUpdate)(MwLL handle, MwLLColor c, int r, int g, int b);
 void (*MwLLFreeColor)(MwLLColor color);

src/widget/opengl.c

@@ -1,6 +1,12 @@
 #include <Mw/Milsko.h>
 #include <Mw/Widget/OpenGL.h>
 
+#ifdef USE_WAYLAND
+#include <stb_ds.h>
+#include <pthread.h>
+#include <sys/time.h>
+#endif
+
 #ifdef USE_GDI
 typedef HGLRC(WINAPI* MWwglCreateContext)(HDC);
 typedef BOOL(WINAPI* MWwglMakeCurrent)(HDC, HGLRC);
@@ -103,6 +109,12 @@ static int create(MwWidget handle) {
 		o->gl	  = o->glXCreateContext(handle->lowlevel->x11.display, o->visual, NULL, GL_TRUE);
 	}
 #endif
+#ifdef USE_WAYLAND
+	/* Wayland uses OpenGL as its backend so its already initialized */
+	if(handle->lowlevel->common.type == MwLLBackendWayland) {
+	}
+#endif
+
 	handle->internal		     = r;
 	handle->lowlevel->common.copy_buffer = 0;
 
@@ -133,6 +145,10 @@ static void destroy(MwWidget handle) {
 		MwDynamicClose(o->lib);
 	}
 #endif
+#ifdef USE_WAYLAND
+/* Wayland uses OpenGL as its backend so its destroyed accordingly */
+#endif
+
 	free(handle->internal);
 }
 
@@ -151,6 +167,10 @@ static void mwOpenGLMakeCurrentImpl(MwWidget handle) {
 		o->glXMakeCurrent(handle->lowlevel->x11.display, handle->lowlevel->x11.window, o->gl);
 	}
 #endif
+#ifdef USE_WAYLAND
+	if(handle->lowlevel->common.type == MwLLBackendWayland) {
+	}
+#endif
 }
 
 static void mwOpenGLSwapBufferImpl(MwWidget handle) {
@@ -168,6 +188,16 @@ static void mwOpenGLSwapBufferImpl(MwWidget handle) {
 		o->glXSwapBuffers(handle->lowlevel->x11.display, handle->lowlevel->x11.window);
 	}
 #endif
+#ifdef USE_WAYLAND
+#define tp handle->lowlevel->wayland.topmost_parent->wayland
+	if(handle->lowlevel->common.type == MwLLBackendWayland) {
+		if(!eglSwapBuffers(
+		       tp.egl_display, tp.egl_surface)) {
+			printf("Userland error: eglSwapBuffers, %0X\n", eglGetError());
+		}
+	}
+#undef topmost_parent
+#endif
 }
 
 static void* mwOpenGLGetProcAddressImpl(MwWidget handle, const char* name) {
@@ -184,6 +214,11 @@ static void* mwOpenGLGetProcAddressImpl(MwWidget handle, const char* name) {
 
 		return o->glXGetProcAddress((const GLubyte*)name);
 	}
+#endif
+#ifdef USE_WAYLAND
+	if(handle->lowlevel->common.type == MwLLBackendWayland) {
+		return eglGetProcAddress(name);
+	}
 #endif
 	return NULL;
 }