debug-control: New interface to control debug settings

It's nice when we can enable things like damage tracking dynamically

Signed-off-by: Guido Günther <[email protected]>
Part-of: <https://gitlab.gnome.org/World/Phosh/phoc/-/merge_requests/622>

.reuse/dep5

@@ -32,6 +32,12 @@ Files:
 Copyright: See individual files
 License: MIT
 
+# DBus protocols have the same copyright as the code
+Files:
+ src/dbus/*.xml
+Copyright: See individual files
+License: GPL-3.0-or-later
+
 # Test data has the same copyright as the tests
 Files:
  tests/data/phosh,tiny.json

src/dbus/meson.build

@@ -0,0 +1,31 @@
+phoc_dbus_inc = include_directories('.')
+
+phoc_dbus_sources = []
+phoc_dbus_headers = []
+
+phoc_dbus_prefix = 'PhocDBus'
+
+#
+# Protocols where Phoc is the DBus client:
+#
+phoc_dbus_client_protos = []
+
+#
+# Protocols where Phoc is the DBus server:
+#
+phoc_dbus_server_protos = [
+  # Sorted by xml filename:
+  ['phoc-dbus-debug-control','mobi.phosh.Phoc.DebugControl.xml', 'mobi.phosh.Phoc'],
+]
+
+foreach p : phoc_dbus_client_protos + phoc_dbus_server_protos
+  name = p[0]
+  xml = p[1]
+  prefix = p[2]
+  targets = gnome.gdbus_codegen(name, xml,
+                                interface_prefix: prefix,
+                                install_header: false,
+                                namespace: phoc_dbus_prefix)
+  phoc_dbus_sources += targets[0]
+  phoc_dbus_headers += targets[1]
+endforeach

src/dbus/mobi.phosh.Phoc.DebugControl.xml

@@ -0,0 +1,27 @@
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+
+  <!--
+      mobi.phosh.DebugControl:
+
+      This interface is exported by the compositor to control its runtime
+      debug settings.
+  -->
+
+  <interface name="mobi.phosh.Phoc.DebugControl">
+    <!--
+        TouchPoints:
+
+        Whether the compositor highlights touch points.
+    -->
+    <property name="TouchPoints" type="b" access="readwrite"/>
+    <!--
+        DamageTracking:
+
+        Whether the compositor highlights damaged areas.
+    -->
+    <property name="DamageTracking" type="b" access="readwrite"/>
+
+  </interface>
+</node>

src/debug-control.c

@@ -0,0 +1,259 @@
+/*
+ * Copyright (C) 2025 The Phosh Developers
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ * Author: Guido Günther <[email protected]>
+ */
+
+#define G_LOG_DOMAIN "phoc-debug-control"
+
+#include "phoc-config.h"
+#include "phoc-enums.h"
+#include "debug-control.h"
+#include "server.h"
+
+#include <gio/gio.h>
+
+#define DEBUG_CONTROL_DBUS_PATH "/mobi/phosh/Phoc/DebugControl"
+#define DEBUG_CONTROL_DBUS_NAME "mobi.phosh.Phoc.DebugControl"
+
+/**
+ * PhocDebugControl:
+ *
+ * DBus Debug control interface
+ */
+
+enum {
+  PROP_0,
+  PROP_SERVER,
+  PROP_EXPORTED,
+  PROP_LAST_PROP
+};
+static GParamSpec *props[PROP_LAST_PROP];
+
+struct _PhocDebugControl {
+  PhocDBusDebugControlSkeleton parent;
+
+  guint                        dbus_name_id;
+  gboolean                     exported;
+};
+
+static void phoc_dbus_debug_control_iface_init (PhocDBusDebugControlIface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (PhocDebugControl, phoc_debug_control,
+                         PHOC_DBUS_TYPE_DEBUG_CONTROL_SKELETON,
+                         G_IMPLEMENT_INTERFACE (PHOC_DBUS_TYPE_DEBUG_CONTROL,
+                                                phoc_dbus_debug_control_iface_init))
+
+static void
+phoc_dbus_debug_control_iface_init (PhocDBusDebugControlIface *iface)
+{
+}
+
+
+static gboolean
+transform_flag_to_bool (GBinding     *binding,
+                        const GValue *from_value,
+                        GValue       *to_value,
+                        gpointer      user_data)
+{
+  guint mask = GPOINTER_TO_UINT (user_data);
+  PhocServerDebugFlags flags = g_value_get_flags (from_value);
+  gboolean enabled = !!(flags & mask);
+
+  g_value_set_boolean (to_value, enabled);
+  return TRUE;
+}
+
+
+static gboolean
+transform_flag_from_bool (GBinding     *binding,
+                          const GValue *from_value,
+                          GValue       *to_value,
+                          gpointer      user_data)
+{
+  g_autoptr (PhocServer) server = PHOC_SERVER (g_binding_dup_source (binding));
+  guint mask = GPOINTER_TO_UINT (user_data);
+  gboolean enable = g_value_get_boolean (from_value);
+  PhocServerDebugFlags flags = phoc_server_get_debug_flags (server);
+
+  if (enable)
+    flags |= mask;
+  else
+    flags &= ~mask;
+
+  g_value_set_flags (to_value, flags);
+  return TRUE;
+}
+
+
+static void
+on_bus_acquired (GDBusConnection *connection, const char *name, gpointer user_data)
+{
+  PhocDebugControl *self = user_data;
+  g_autoptr (GError) err = NULL;
+
+  if (g_dbus_interface_skeleton_export (G_DBUS_INTERFACE_SKELETON (self),
+                                        connection,
+                                        DEBUG_CONTROL_DBUS_PATH,
+                                        &err)) {
+    self->exported = TRUE;
+    g_object_notify_by_pspec (G_OBJECT (self), props[PROP_EXPORTED]);
+    g_debug ("Debug interface exported on '%s'", DEBUG_CONTROL_DBUS_NAME);
+  } else {
+    g_warning ("Failed to export on %s: %s", DEBUG_CONTROL_DBUS_NAME, err->message);
+  }
+}
+
+
+static void
+phoc_debug_control_set_server (PhocDebugControl *self, PhocServer *server)
+{
+  g_autoptr (GFlagsClass) eclass = NULL;
+  PhocServerDebugFlags exported[] = {
+    PHOC_SERVER_DEBUG_FLAG_TOUCH_POINTS,
+    PHOC_SERVER_DEBUG_FLAG_DAMAGE_TRACKING,
+  };
+
+  eclass = G_FLAGS_CLASS (g_type_class_ref (phoc_server_debug_flags_get_type ()));
+  for (int i = 0; i < G_N_ELEMENTS (exported); i++) {
+    PhocServerDebugFlags flag = exported[i];
+    GFlagsValue *fv = g_flags_get_first_value (eclass, flag);
+    if (!fv) {
+      g_critical ("Got invalid debug flag value: %d", flag);
+      continue;
+    }
+    g_object_bind_property_full (server,
+                                 "debug-flags",
+                                 self,
+                                 fv->value_nick,
+                                 G_BINDING_SYNC_CREATE |
+                                 G_BINDING_BIDIRECTIONAL,
+                                 transform_flag_to_bool,
+                                 transform_flag_from_bool,
+                                 GUINT_TO_POINTER (flag),
+                                 NULL);
+  }
+}
+
+
+static void
+phoc_debug_control_set_property (GObject      *object,
+                                 guint         property_id,
+                                 const GValue *value,
+                                 GParamSpec   *pspec)
+{
+  PhocDebugControl *self = PHOC_DEBUG_CONTROL (object);
+
+  switch (property_id) {
+  case PROP_SERVER:
+    phoc_debug_control_set_server (self, g_value_get_object (value));
+    break;
+  case PROP_EXPORTED:
+    phoc_debug_control_set_exported (self, g_value_get_boolean (value));
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+    break;
+  }
+}
+
+
+static void
+phoc_debug_control_get_property (GObject    *object,
+                                 guint       property_id,
+                                 GValue     *value,
+                                 GParamSpec *pspec)
+{
+  PhocDebugControl *self = PHOC_DEBUG_CONTROL (object);
+
+  switch (property_id) {
+  case PROP_EXPORTED:
+    g_value_set_boolean (value, self->exported);
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+    break;
+  }
+}
+
+
+static void
+phoc_debug_control_dispose (GObject *object)
+{
+  PhocDebugControl *self = PHOC_DEBUG_CONTROL (object);
+
+  if (self->exported) {
+    g_dbus_interface_skeleton_unexport (G_DBUS_INTERFACE_SKELETON (self));
+    self->exported = FALSE;
+  }
+  g_clear_handle_id (&self->dbus_name_id, g_bus_unown_name);
+
+  G_OBJECT_CLASS (phoc_debug_control_parent_class)->dispose (object);
+}
+
+
+static void
+phoc_debug_control_class_init (PhocDebugControlClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->get_property = phoc_debug_control_get_property;
+  object_class->set_property = phoc_debug_control_set_property;
+  object_class->dispose = phoc_debug_control_dispose;
+
+  props[PROP_SERVER] =
+    g_param_spec_object ("server", "", "",
+                         PHOC_TYPE_SERVER,
+                         G_PARAM_READWRITE |
+                         G_PARAM_CONSTRUCT_ONLY |
+                         G_PARAM_STATIC_STRINGS);
+
+  props[PROP_EXPORTED] =
+    g_param_spec_boolean ("exported", "", "",
+                          FALSE,
+                          G_PARAM_READWRITE |
+                          G_PARAM_EXPLICIT_NOTIFY |
+                          G_PARAM_STATIC_STRINGS);
+
+  g_object_class_install_properties (object_class, PROP_LAST_PROP, props);
+}
+
+
+static void
+phoc_debug_control_init (PhocDebugControl *self)
+{
+}
+
+
+PhocDebugControl *
+phoc_debug_control_new (PhocServer *server)
+{
+  return g_object_new (PHOC_TYPE_DEBUG_CONTROL, "server", server, NULL);
+}
+
+
+void
+phoc_debug_control_set_exported (PhocDebugControl *self, gboolean exported)
+{
+  g_assert (PHOC_IS_DEBUG_CONTROL (self));
+
+  if (self->exported == exported)
+    return;
+
+  if (exported) {
+    self->dbus_name_id = g_bus_own_name (G_BUS_TYPE_SESSION,
+                                         DEBUG_CONTROL_DBUS_NAME,
+                                         G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT,
+                                         on_bus_acquired,
+                                         NULL,
+                                         NULL,
+                                         self,
+                                         NULL);
+  } else {
+    g_clear_handle_id (&self->dbus_name_id, g_bus_unown_name);
+    self->exported = FALSE;
+    g_object_notify_by_pspec (G_OBJECT (self), props[PROP_EXPORTED]);
+  }
+}

src/debug-control.h

@@ -0,0 +1,25 @@
+/*
+ * Copyright (C) 2025 The Phosh Developers
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#pragma once
+
+#include "phoc-dbus-debug-control.h"
+#include "server.h"
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define PHOC_TYPE_DEBUG_CONTROL (phoc_debug_control_get_type ())
+
+G_DECLARE_FINAL_TYPE (PhocDebugControl, phoc_debug_control, PHOC, DEBUG_CONTROL,
+                      PhocDBusDebugControlSkeleton)
+
+PhocDebugControl       *phoc_debug_control_new                   (PhocServer       *server);
+void                    phoc_debug_control_set_exported          (PhocDebugControl *self,
+                                                                  gboolean          exported);
+
+G_END_DECLS