[gtk/magnifier-shadow: 1/3] widgetpaintable: Add an observed area enum

[Matthias Clasen <matthiasc src gnome org>]

commit 27dab3cc39ab4b85be1929cc4a444baa73a29adb
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu May 5 15:20:25 2022 -0400

    widgetpaintable: Add an observed area enum
    
    This can be used to capture just the widget area, or
    all of the rendered area (including shadows, etc).

 gtk/gtkwidgetpaintable.c | 71 ++++++++++++++++++++++++++++++++++++++++++++++--
 gtk/gtkwidgetpaintable.h | 21 ++++++++++++++
 2 files changed, 89 insertions(+), 3 deletions(-)
---
diff --git a/gtk/gtkwidgetpaintable.c b/gtk/gtkwidgetpaintable.c
index 50ea1582fb..4526da976f 100644
--- a/gtk/gtkwidgetpaintable.c
+++ b/gtk/gtkwidgetpaintable.c
@@ -24,6 +24,7 @@
 #include "gtkintl.h"
 #include "gtksnapshot.h"
 #include "gtkrendernodepaintableprivate.h"
+#include "gtktypebuiltins.h"
 #include "gtkwidgetprivate.h"
 
 /**
@@ -61,6 +62,8 @@ struct _GtkWidgetPaintable
 
   GdkPaintable *current_image;          /* the image that we are presenting */
   GdkPaintable *pending_image;          /* the image that we should be presenting */
+
+  GtkWidgetPaintableArea area;
 };
 
 struct _GtkWidgetPaintableClass
@@ -71,12 +74,28 @@ struct _GtkWidgetPaintableClass
 enum {
   PROP_0,
   PROP_WIDGET,
+  PROP_OBSERVED_AREA,
 
   N_PROPS,
 };
 
 static GParamSpec *properties[N_PROPS] = { NULL, };
 
+static gboolean
+gtk_widget_paintable_compute_bounds (GtkWidgetPaintable *self,
+                                     graphene_rect_t    *bounds)
+{
+  if (self->area == GTK_WIDGET_PAINTABLE_AREA_WIDGET)
+    return gtk_widget_compute_bounds (self->widget, self->widget, bounds);
+  else if (self->widget->priv->render_node)
+    {
+      gsk_render_node_get_bounds (self->widget->priv->render_node, bounds);
+      return TRUE;
+    }
+
+  return FALSE;
+}
+
 static void
 gtk_widget_paintable_paintable_snapshot (GdkPaintable *paintable,
                                          GdkSnapshot  *snapshot,
@@ -94,7 +113,7 @@ gtk_widget_paintable_paintable_snapshot (GdkPaintable *paintable,
       gtk_snapshot_push_clip (snapshot,
                               &GRAPHENE_RECT_INIT(0, 0, width, height));
 
-      if (gtk_widget_compute_bounds (self->widget, self->widget, &bounds))
+      if (gtk_widget_paintable_compute_bounds (self, &bounds))
         {
           gtk_snapshot_scale (snapshot, width / bounds.size.width, height / bounds.size.height);
           gtk_snapshot_translate (snapshot, &bounds.origin);
@@ -162,6 +181,10 @@ gtk_widget_paintable_set_property (GObject      *object,
       gtk_widget_paintable_set_widget (self, g_value_get_object (value));
       break;
 
+    case PROP_OBSERVED_AREA:
+      gtk_widget_paintable_set_observed_area (self, g_value_get_enum (value));
+      break;
+
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -182,6 +205,10 @@ gtk_widget_paintable_get_property (GObject    *object,
       g_value_set_object (value, self->widget);
       break;
 
+    case PROP_OBSERVED_AREA:
+      g_value_set_enum (value, self->area);
+      break;
+
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -249,6 +276,14 @@ gtk_widget_paintable_class_init (GtkWidgetPaintableClass *klass)
                          GTK_TYPE_WIDGET,
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
 
+  properties[PROP_OBSERVED_AREA] =
+    g_param_spec_enum ("observed-area",
+                       P_("Area"),
+                       P_("Observed area"),
+                       GTK_TYPE_WIDGET_PAINTABLE_AREA,
+                       GTK_WIDGET_PAINTABLE_AREA_WIDGET,
+                       G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
+
   g_object_class_install_properties (gobject_class, N_PROPS, properties);
 }
 
@@ -256,6 +291,7 @@ static void
 gtk_widget_paintable_init (GtkWidgetPaintable *self)
 {
   self->current_image = gdk_paintable_new_empty (0, 0);
+  self->area = GTK_WIDGET_PAINTABLE_AREA_WIDGET;
 }
 
 /**
@@ -284,12 +320,12 @@ gtk_widget_paintable_snapshot_widget (GtkWidgetPaintable *self)
   if (self->widget == NULL)
     return gdk_paintable_new_empty (0, 0);
 
-  if (!gtk_widget_compute_bounds (self->widget, self->widget, &bounds))
+  if (!gtk_widget_paintable_compute_bounds (self, &bounds))
     return gdk_paintable_new_empty (0, 0);
 
   if (self->widget->priv->render_node == NULL)
     return gdk_paintable_new_empty (bounds.size.width, bounds.size.height);
-  
+
   return gtk_render_node_paintable_new (self->widget->priv->render_node, &bounds);
 }
 
@@ -404,3 +440,32 @@ gtk_widget_paintable_pop_snapshot_count (GtkWidgetPaintable *self)
 {
   self->snapshot_count--;
 }
+
+/**
+ * gtk_widget_paintable_set_observed_area:
+ * @self: a `GtkWidgetPaintable`
+ * @area: the area to observe
+ *
+ * Sets what area the paintable should observe.
+ *
+ * Since: 4.8
+ */
+void
+gtk_widget_paintable_set_observed_area (GtkWidgetPaintable     *self,
+                                        GtkWidgetPaintableArea  area)
+{
+  if (self->area == area)
+    return;
+
+  self->area = area;
+
+  g_object_notify (G_OBJECT (self), "observed-area");
+  gdk_paintable_invalidate_size (GDK_PAINTABLE (self));
+  gdk_paintable_invalidate_contents (GDK_PAINTABLE (self));
+}
+
+GtkWidgetPaintableArea
+gtk_widget_paintable_get_observed_area (GtkWidgetPaintable *self)
+{
+  return self->area;
+}
diff --git a/gtk/gtkwidgetpaintable.h b/gtk/gtkwidgetpaintable.h
index 3af7ddf137..5343af4de4 100644
--- a/gtk/gtkwidgetpaintable.h
+++ b/gtk/gtkwidgetpaintable.h
@@ -38,6 +38,27 @@ GDK_AVAILABLE_IN_ALL
 void            gtk_widget_paintable_set_widget         (GtkWidgetPaintable     *self,
                                                          GtkWidget              *widget);
 
+/**
+ * GtkWidgetPaintableArea:
+ * @GTK_WIDGET_PAINTABLE_AREA_WIDGET: Restrict the paintable to the widget bounds
+ * @GTK_WIDGET_PAINTABLE_AREA_RENDERED: Include all render nodes produced by the
+ *   widget in the paintable area
+ *
+ * Used to indicate what area should be captured by a widget paintable.
+ */
+typedef enum {
+  GTK_WIDGET_PAINTABLE_AREA_WIDGET,
+  GTK_WIDGET_PAINTABLE_AREA_RENDERED
+} GtkWidgetPaintableArea;
+
+GDK_AVAILABLE_IN_4_8
+void            gtk_widget_paintable_set_observed_area  (GtkWidgetPaintable     *self,
+                                                         GtkWidgetPaintableArea  area);
+
+GDK_AVAILABLE_IN_4_8
+GtkWidgetPaintableArea
+                gtk_widget_paintable_get_observed_area  (GtkWidgetPaintable     *self);
+
 G_END_DECLS
 
 #endif /* __GTK_WIDGET_PAINTABLE_H__ */