[gtk/wip/otte/listview: 18/152] expression: Add gtk_expression_bind()

[Benjamin Otte <otte src gnome org>]

commit 2d945b1f3075af26291ab9313fe602bef1b7e08c
Author: Benjamin Otte <otte redhat com>
Date:   Sun Nov 24 08:05:41 2019 +0100

    expression: Add gtk_expression_bind()
    
    Add a simple way to bind expressions to object properties. This is
    essentially the thing to replace g_object_bind_property().

 gtk/gtkexpression.c | 118 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 gtk/gtkexpression.h |   5 +++
 2 files changed, 123 insertions(+)
---
diff --git a/gtk/gtkexpression.c b/gtk/gtkexpression.c
index fe382fb09c..2a16ac0bab 100644
--- a/gtk/gtkexpression.c
+++ b/gtk/gtkexpression.c
@@ -1104,3 +1104,121 @@ gtk_expression_watch_evaluate (GtkExpressionWatch *watch,
 
   return gtk_expression_evaluate (watch->expression, watch->this, value);
 }
+
+typedef struct {
+  GtkExpressionWatch *watch;
+  GtkExpression *expression;
+  GObject *object;
+  GParamSpec *pspec;
+} GtkExpressionBind;
+
+static void
+free_binds (gpointer data)
+{
+  GSList *l;
+
+  for (l = data; l; l = l->next)
+    {
+      GtkExpressionBind *bind = l->data;
+
+      bind->object = NULL;
+      gtk_expression_watch_unwatch (bind->watch);
+    }
+  g_slist_free (data);
+}
+
+static void
+gtk_expression_bind_free (gpointer data)
+{
+  GtkExpressionBind *bind = data;
+
+  if (bind->object)
+    {
+      GSList *binds;
+      binds = g_object_steal_data (bind->object, "gtk-expression-binds");
+      binds = g_slist_remove (binds, bind);
+      if (binds)
+        g_object_set_data_full (bind->object, "gtk-expression-binds", binds, free_binds);
+    }
+  gtk_expression_unref (bind->expression);
+
+  g_slice_free (GtkExpressionBind, bind);
+}
+
+static void
+gtk_expression_bind_notify (gpointer data)
+{
+  GValue value = G_VALUE_INIT;
+  GtkExpressionBind *bind = data;
+
+  if (!gtk_expression_evaluate (bind->expression, bind->object, &value))
+    return;
+
+  g_object_set_property (bind->object, bind->pspec->name, &value);
+  g_value_unset (&value);
+}
+
+/**
+ * gtk_expression_bind:
+ * @self: (transfer full): a #GtkExpression
+ * @object: (transfer none) (type GObject): the object to bind
+ * @property: name of the property to bind to
+ *
+ * Bind @object's property named @property to @self.
+ *
+ * The value that @self evaluates to is set via g_object_set() on
+ * @object. This is repeated whenever @self changes to ensure that
+ * the object's property stays synchronized with @self.
+ *
+ * If @self's evaluation fails, @object's @property is not updated.
+ * You can ensure that this doesn't happen by using a fallback
+ * expression.
+ *
+ * Note that this function takes ownership of @self. If you want
+ * to keep it around, you should gtk_expression_ref() it beforehand.
+ *
+ * Returns: (transfer none): a #GtkExpressionWatch
+ **/
+GtkExpressionWatch *
+gtk_expression_bind (GtkExpression *self,
+                     gpointer       object,
+                     const char    *property)
+{
+  GtkExpressionBind *bind;
+  GParamSpec *pspec;
+  GSList *binds;
+
+  g_return_val_if_fail (GTK_IS_EXPRESSION (self), NULL);
+  g_return_val_if_fail (G_IS_OBJECT (object), NULL);
+  g_return_val_if_fail (property != NULL, NULL);
+  pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
+  if (G_UNLIKELY (pspec == NULL))
+    {
+      g_critical ("%s: Class '%s' has no property named '%s'",
+                  G_STRFUNC, G_OBJECT_TYPE_NAME (object), property);
+      return NULL;
+    }
+  if (G_UNLIKELY ((pspec->flags & (G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY)) != G_PARAM_WRITABLE))
+    {
+      g_critical ("%s: property '%s' of class '%s' is not writable",
+                 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
+      return NULL;
+    }
+
+  bind = g_slice_new0 (GtkExpressionBind);
+  bind->expression = self;
+  bind->object = object;
+  bind->pspec = pspec;
+  bind->watch = gtk_expression_watch (self,
+                                      object,
+                                      gtk_expression_bind_notify,
+                                      bind,
+                                      gtk_expression_bind_free);
+  binds = g_object_steal_data (object, "gtk-expression-binds");
+  binds = g_slist_prepend (binds, bind);
+  g_object_set_data_full (object, "gtk-expression-binds", binds, free_binds);
+
+  gtk_expression_bind_notify (bind);
+
+  return bind->watch;
+}
diff --git a/gtk/gtkexpression.h b/gtk/gtkexpression.h
index 4e2e75be6e..bac7762561 100644
--- a/gtk/gtkexpression.h
+++ b/gtk/gtkexpression.h
@@ -57,6 +57,11 @@ GtkExpressionWatch *    gtk_expression_watch                    (GtkExpression
                                                                  gpointer                        user_data,
                                                                  GDestroyNotify                  
user_destroy);
 GDK_AVAILABLE_IN_ALL
+GtkExpressionWatch *    gtk_expression_bind                     (GtkExpression                  *self,
+                                                                 gpointer                        object,
+                                                                 const char *                    property);
+
+GDK_AVAILABLE_IN_ALL
 GtkExpressionWatch *    gtk_expression_watch_ref                (GtkExpressionWatch             *watch);
 GDK_AVAILABLE_IN_ALL
 void                    gtk_expression_watch_unref              (GtkExpressionWatch             *watch);