Merge branch 'monitor-description' into 'main'

Add GdkMonitor::description

See merge request GNOME/gtk!5466

gdk/gdkmonitor.c

@@ -39,6 +39,7 @@
 
 enum {
   PROP_0,
+  PROP_DESCRIPTION,
   PROP_DISPLAY,
   PROP_MANUFACTURER,
   PROP_MODEL,
@@ -81,6 +82,10 @@ gdk_monitor_get_property (GObject    *object,
 
   switch (prop_id)
     {
+    case PROP_DESCRIPTION:
+      g_value_set_string (value, monitor->description);
+      break;
+
     case PROP_DISPLAY:
       g_value_set_object (value, monitor->display);
       break;
@@ -154,6 +159,7 @@ gdk_monitor_finalize (GObject *object)
 {
   GdkMonitor *monitor = GDK_MONITOR (object);
 
+  g_free (monitor->description);
   g_free (monitor->connector);
   g_free (monitor->manufacturer);
   g_free (monitor->model);
@@ -170,6 +176,18 @@ gdk_monitor_class_init (GdkMonitorClass *class)
   object_class->get_property = gdk_monitor_get_property;
   object_class->set_property = gdk_monitor_set_property;
 
+  /**
+   * GdkMonitor:description: (attributes org.gtk.Property.get=gdk_monitor_get_description)
+   *
+   * A short description of the monitor, meant for display to the user.
+   *
+   * Since: 4.10
+   */
+  props[PROP_DESCRIPTION] =
+    g_param_spec_string ("description", NULL, NULL,
+                         NULL,
+                         G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+
   /**
    * GdkMonitor:display: (attributes org.gtk.Property.get=gdk_monitor_get_display)
    *
@@ -377,6 +395,10 @@ gdk_monitor_get_height_mm (GdkMonitor *monitor)
  *
  * Gets the name of the monitor's connector, if available.
  *
+ * These are strings such as "eDP-1", or "HDMI-2". They depend
+ * on software and hardware configuration, and should not be
+ * relied on as stable identifiers of a specific monitor.
+ *
  * Returns: (transfer none) (nullable): the name of the connector
  */
 const char *
@@ -619,3 +641,33 @@ gdk_monitor_is_valid (GdkMonitor *monitor)
 
   return monitor->valid;
 }
+
+/**
+ * gdk_monitor_get_description: (attributes org.gtk.Method.get_property=description)
+ * @monitor: a `GdkMonitor`
+ *
+ * Gets a string describing the monitor, if available.
+ *
+ * This can be used to identify a monitor in the UI.
+ *
+ * Returns: (transfer none) (nullable): the monitor description
+ *
+ * Since: 4.10
+ */
+const char *
+gdk_monitor_get_description (GdkMonitor *monitor)
+{
+  g_return_val_if_fail (GDK_IS_MONITOR (monitor), NULL);
+
+  return monitor->description;
+}
+
+void
+gdk_monitor_set_description (GdkMonitor *monitor,
+                             const char *description)
+{
+  g_free (monitor->description);
+  monitor->description = g_strdup (description);
+  g_object_notify_by_pspec (G_OBJECT (monitor), props[PROP_DESCRIPTION]);
+}
+

gdk/gdkmonitor.h

@@ -86,6 +86,8 @@ GDK_AVAILABLE_IN_ALL
 GdkSubpixelLayout gdk_monitor_get_subpixel_layout (GdkMonitor   *monitor);
 GDK_AVAILABLE_IN_ALL
 gboolean          gdk_monitor_is_valid            (GdkMonitor   *monitor);
+GDK_AVAILABLE_IN_4_10
+const char *      gdk_monitor_get_description     (GdkMonitor   *monitor);
 
 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GdkMonitor, g_object_unref)
 

gdk/gdkmonitorprivate.h

@@ -37,6 +37,7 @@ struct _GdkMonitor {
   char *manufacturer;
   char *model;
   char *connector;
+  char *description;
   GdkRectangle geometry;
   int width_mm;
   int height_mm;
@@ -70,6 +71,8 @@ void            gdk_monitor_set_refresh_rate    (GdkMonitor *monitor,
 void            gdk_monitor_set_subpixel_layout (GdkMonitor        *monitor,
                                                  GdkSubpixelLayout  subpixel);
 void            gdk_monitor_invalidate          (GdkMonitor *monitor);
+void            gdk_monitor_set_description     (GdkMonitor *monitor,
+                                                 const char *description);
 
 G_END_DECLS
 

gdk/wayland/gdkdisplay-wayland.c

@@ -2332,6 +2332,7 @@ apply_monitor_change (GdkWaylandMonitor *monitor)
                               monitor->x, monitor->y,
                               monitor->width, monitor->height });
   gdk_monitor_set_connector (GDK_MONITOR (monitor), monitor->name);
+  gdk_monitor_set_description (GDK_MONITOR (monitor), monitor->description);
   monitor->wl_output_done = FALSE;
   monitor->xdg_output_done = FALSE;
 
@@ -2388,7 +2389,7 @@ xdg_output_handle_name (void                  *data,
 {
   GdkWaylandMonitor *monitor = (GdkWaylandMonitor *) data;
 
-  GDK_DEBUG (MISC, "handle name xdg-output %d", monitor->id);
+  GDK_DEBUG (MISC, "handle name xdg-output %d: %s", monitor->id, name);
 
   monitor->name = g_strdup (name);
 }
@@ -2398,8 +2399,11 @@ xdg_output_handle_description (void                  *data,
                                struct zxdg_output_v1 *xdg_output,
                                const char            *description)
 {
-  GDK_DEBUG (MISC, "handle description xdg-output %d",
-                   ((GdkWaylandMonitor *)data)->id);
+  GdkWaylandMonitor *monitor = (GdkWaylandMonitor *) data;
+
+  GDK_DEBUG (MISC, "handle description xdg-output %d: %s", monitor->id, description);
+
+  monitor->description = g_strdup (description);
 }
 
 static const struct zxdg_output_v1_listener xdg_output_listener = {

gdk/wayland/gdkmonitor-wayland.c

@@ -46,6 +46,7 @@ gdk_wayland_monitor_finalize (GObject *object)
   GdkWaylandMonitor *monitor = (GdkWaylandMonitor *)object;
 
   g_free (monitor->name);
+  g_free (monitor->description);
 
   g_clear_pointer (&monitor->xdg_output, zxdg_output_v1_destroy);
 

gdk/wayland/gdkmonitor-wayland.h

@@ -38,6 +38,7 @@ struct _GdkWaylandMonitor {
   int32_t width;
   int32_t height;
   char *name;
+  char *description;
   gboolean wl_output_done;
   gboolean xdg_output_done;
 };

gtk/inspector/general.c

@@ -650,6 +650,7 @@ add_monitor (GtkInspectorGeneral *gen,
   g_free (value);
   g_free (name);
 
+  add_label_row (gen, list, "Description", gdk_monitor_get_description (monitor), 10);
   add_label_row (gen, list, "Connector", gdk_monitor_get_connector (monitor), 10);
 
   gdk_monitor_get_geometry (monitor, &rect);