Immersive backend

.clang-tidy

@@ -12,13 +12,19 @@ Checks: "
 
   cppcoreguidelines-*,
   -cppcoreguidelines-avoid-magic-numbers,
+  -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+  -cppcoreguidelines-pro-type-vararg,
+  -cppcoreguidelines-macro-usage,
 
   google-*,
 
   misc-*,
   -misc-no-recursion,
 
   modernize-*,
+  -modernize-use-nodiscard,
+  -modernize-use-trailing-return-type,
+
   performance-*,
   portability-*,
 
@@ -28,5 +34,8 @@ Checks: "
 
   *-cloexec-*,
 "
+CheckOptions:
+- key:    'cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor'
+  value:  'true'
 WarningsAsErrors: '*'
 FormatStyle: file

.github/workflows/test.yaml

@@ -25,14 +25,22 @@ jobs:
     steps:
       - name: Install dependencies
         run: |
-          echo "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-15 main" | sudo tee -a /etc/apt/sources.list
-          echo "deb-src http://apt.llvm.org/jammy/ llvm-toolchain-jammy-15 main" | sudo tee -a /etc/apt/sources.list
-          wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
           sudo apt-get update
           sudo apt-get install \
             libwayland-dev libwlroots-dev libpixman-1-dev \
             libxkbcommon-dev libglu1-mesa-dev libglew-dev \
-            meson libfreetype-dev librsvg2-dev libcglm-dev clang-15
+            meson libfreetype-dev librsvg2-dev libcglm-dev
+
+      - name: Install clang15
+        if: matrix.clang-version == 15
+        run: |
+          echo "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-15 main" | sudo tee -a /etc/apt/sources.list
+          echo "deb-src http://apt.llvm.org/jammy/ llvm-toolchain-jammy-15 main" | sudo tee -a /etc/apt/sources.list
+          wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+          sudo apt-get update
+          sudo apt-get install clang-15 clang-format-15 clang-tidy-15
+          sudo ln -sf /usr/bin/clang-tidy-15 /usr/bin/clang-tidy
+          sudo ln -sf /usr/bin/clang-format-15 /usr/bin/clang-format
 
       - uses: actions/setup-python@v1
         with:
@@ -46,12 +54,25 @@ jobs:
           unzip grpc-dev.zip
         working-directory: ./grpc-dev
 
+      - name: Clone zen-protocols
+        uses: actions/checkout@v2
+        with:
+          repository: zwin-project/zen-protocols
+          path: zen-protocols
+
+      - name: Install zen-protocols
+        working-directory: ./zen-protocols
+        run: |
+          meson build
+          sudo ninja -C build install
+
       - name: Clone zen-remote
         uses: actions/checkout@v2
         with:
           repository: zwin-project/zen-remote
           path: zen-remote
           submodules: recursive
+          ref: 'v0.2.0'
 
       - name: Build zen-remote
         working-directory: ./zen-remote
@@ -65,6 +86,7 @@ jobs:
         with:
           repository: zwin-project/zwin
           path: zwin
+          ref: 'v0.2.0'
 
       - name: Build zwin
         working-directory: ./zwin

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Akihiro Kiuchi & Taishi Eguchi
+Copyright (c) 2023 Zwin Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

common/include/zen-common/cpp-util.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#ifdef __cplusplus
+
+// NOLINTBEGIN(bugprone-macro-parentheses)
+#define DISABLE_MOVE_AND_COPY(Class)        \
+  Class(const Class &) = delete;            \
+  Class(Class &&) = delete;                 \
+  Class &operator=(const Class &) = delete; \
+  Class &operator=(Class &&) = delete
+// NOLINTEND(bugprone-macro-parentheses)
+
+#endif

common/include/zen-common/delay-signal.h

@@ -0,0 +1,22 @@
+#pragma once
+
+#include <wayland-server.h>
+
+struct zn_delay_signal {
+  struct wl_signal signal;
+  struct wl_event_source *idle;  // @nonnull, @ref
+};
+
+/// The signal handlers will be called at the next idle time.
+/// No user data is allowed as it's hard to manage the ownership of the data.
+/// In there is already a scheduled signal, this signal scheduling will be
+/// ignored.
+void zn_delay_signal_schedule(
+    struct zn_delay_signal *self, struct wl_display *display);
+
+void zn_delay_signal_add(
+    struct zn_delay_signal *self, struct wl_listener *listener);
+
+void zn_delay_signal_init(struct zn_delay_signal *self);
+
+void zn_delay_signal_release(struct zn_delay_signal *self);

common/include/zen-common/log.h

@@ -5,6 +5,8 @@
 #include <stdbool.h>
 #include <string.h>
 
+#include "util.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -36,7 +38,8 @@ void zn_vlog_(zn_log_importance_t verbosity, const char *format, va_list args)
 
 void zn_abort_(const char *format, ...) ATTRIB_PRINTF(1, 2);
 
-bool zn_assert_(bool condition, const char *format, ...) ATTRIB_PRINTF(2, 3);
+bool zn_assert_handler_(const char *format, ...)
+    ATTRIB_PRINTF(1, 2) CLANG_ANALYZER_NORETURN;
 
 #define zn_log(verb, fmt, ...) \
   zn_log_(verb, "[zen] [%s:%d] " fmt, __FILE__, __LINE__, ##__VA_ARGS__)
@@ -59,9 +62,9 @@ bool zn_assert_(bool condition, const char *format, ...) ATTRIB_PRINTF(2, 3);
 #define zn_abort(fmt, ...) \
   zn_abort_("[zen] [%s:%d] " fmt, __FILE__, __LINE__, ##__VA_ARGS__)
 
-#define zn_assert(cond, fmt, ...)                                          \
-  zn_assert_(cond, "[zen] [%s:%d] %s: " fmt, __FILE__, __LINE__, __func__, \
-      ##__VA_ARGS__)
+#define zn_assert(cond, fmt, ...) \
+  (cond || zn_assert_handler_(    \
+               "[zen] [%s:%d] " fmt, __FILE__, __LINE__, ##__VA_ARGS__))
 
 #define zn_warn_once(fmt, ...)                                                \
   {                                                                           \

common/include/zen-common/util.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include <stddef.h>
-#include <stdlib.h>
+#include <stddef.h>  // NOLINT(modernize-deprecated-headers)
+#include <stdlib.h>  // NOLINT(modernize-deprecated-headers)
 
 #ifdef __cplusplus
 extern "C" {
@@ -28,11 +28,19 @@ extern "C" {
 #endif
 #endif
 
+#ifndef CLANG_ANALYZER_NORETURN
+#if __has_feature(attribute_analyzer_noreturn)
+#define CLANG_ANALYZER_NORETURN __attribute__((analyzer_noreturn))
+#else
+#define CLANG_ANALYZER_NORETURN
+#endif
+#endif
+
 /** Allocate memory and set to zero */
 UNUSED static inline void *
 zalloc(size_t size)
 {
-  return calloc(1, size);
+  return calloc(1, size);  // NOLINT(cppcoreguidelines-*)
 }
 
 #define ZN_MAX(a, b) ((a) > (b) ? (a) : (b))
@@ -42,16 +50,6 @@ zalloc(size_t size)
 #define zn_container_of(ptr, sample, member) \
   (__typeof__(sample))((char *)(ptr)-offsetof(__typeof__(*(sample)), member))
 
-#ifdef __cplusplus
-
-#define DISABLE_MOVE_AND_COPY(Class)        \
-  Class(const Class &) = delete;            \
-  Class(Class &&) = delete;                 \
-  Class &operator=(const Class &) = delete; \
-  Class &operator=(Class &&) = delete
-
-#endif
-
 #ifdef __cplusplus
 }
 #endif

common/include/zen-common/wl-array.h

@@ -0,0 +1,26 @@
+#pragma once
+
+#include <cglm/types.h>
+#include <stdbool.h>
+#include <wayland-util.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/// @return true if successful, false otherwise
+bool zn_wl_array_to_int64_t(struct wl_array *array, int64_t *value);
+
+/// @return true if successful, false otherwise
+bool zn_wl_array_to_uint64_t(struct wl_array *array, uint64_t *value);
+
+/// @return true if successful, false otherwise
+/// @param array must be initialized
+bool zn_wl_array_from_vec3(struct wl_array *array, vec3 value);
+
+/// @return true if successful, false otherwise
+bool zn_wl_array_to_vec3(struct wl_array *array, vec3 value);
+
+#ifdef __cplusplus
+}
+#endif

common/meson.build

@@ -1,8 +1,10 @@
 _zen_common_srcs = [
   'src/cairo/rounded.c',
+  'src/delay-signal.c',
   'src/log.c',
   'src/signal.c',
   'src/terminate.c',
+  'src/wl-array.c',
   'src/wlr/box.c',
 ]
 

common/src/delay-signal.c

@@ -0,0 +1,49 @@
+#include "zen-common/delay-signal.h"
+
+#include "zen-common/signal.h"
+#include "zen-common/util.h"
+
+static void
+zn_delay_signal_idle_timer(void *data)
+{
+  struct zn_delay_signal *self = data;
+
+  self->idle = NULL;
+
+  zn_signal_emit_mutable(&self->signal, NULL);
+}
+
+void
+zn_delay_signal_schedule(
+    struct zn_delay_signal *self, struct wl_display *display)
+{
+  if (self->idle) {
+    return;
+  }
+
+  struct wl_event_loop *loop = wl_display_get_event_loop(display);
+
+  self->idle = wl_event_loop_add_idle(loop, zn_delay_signal_idle_timer, self);
+}
+
+void
+zn_delay_signal_add(struct zn_delay_signal *self, struct wl_listener *listener)
+{
+  wl_signal_add(&self->signal, listener);
+}
+
+void
+zn_delay_signal_init(struct zn_delay_signal *self)
+{
+  wl_signal_init(&self->signal);
+  self->idle = NULL;
+}
+
+void
+zn_delay_signal_release(struct zn_delay_signal *self)
+{
+  wl_list_remove(&self->signal.listener_list);
+  if (self->idle) {
+    wl_event_source_remove(self->idle);
+  }
+}

common/src/log.c

@@ -121,12 +121,8 @@ zn_abort_(const char *format, ...)
 }
 
 bool
-zn_assert_(bool condition, const char *format, ...)
+zn_assert_handler_(const char *format, ...)
 {
-  if (condition) {
-    return true;
-  }
-
   va_list args;
   va_start(args, format);
   zn_vlog_(ZEN_ERROR, format, args);

common/src/wl-array.c

@@ -0,0 +1,52 @@
+#include "zen-common/wl-array.h"
+
+#include <string.h>
+
+bool
+zn_wl_array_to_int64_t(struct wl_array *array, int64_t *value)
+{
+  if (array->size != sizeof(*value)) {
+    return false;
+  }
+
+  memcpy(value, array->data, array->size);
+
+  return true;
+}
+
+bool
+zn_wl_array_to_uint64_t(struct wl_array *array, uint64_t *value)
+{
+  if (array->size != sizeof(*value)) {
+    return false;
+  }
+
+  memcpy(value, array->data, array->size);
+
+  return true;
+}
+
+bool
+zn_wl_array_from_vec3(struct wl_array *array, vec3 value)
+{
+  void *data = wl_array_add(array, sizeof(vec3));
+  if (data == NULL) {
+    return false;
+  }
+
+  memcpy(data, value, sizeof(vec3));
+
+  return true;
+}
+
+bool
+zn_wl_array_to_vec3(struct wl_array *array, vec3 value)
+{
+  if (array->size != sizeof(vec3)) {
+    return false;
+  }
+
+  memcpy(value, array->data, array->size);
+
+  return true;
+}