From 33b9865651a81a041751750dc11579a9a35918fa Mon Sep 17 00:00:00 2001
From: Tristan Van Berkom <tristanvb@openismus.com>
Date: Fri, 5 Apr 2013 16:32:56 +0900
Subject: [PATCH] Added test case to assert all object types finalize properly.

The test case uses a weak ref to assert objects can finalize,
and then spins the main loop shortly after finalizing to assert
that the finalized object did not leak GSources into the main context
causing latent crashes.
---
 gtk/tests/Makefile.am        |   5 ++
 gtk/tests/objects-finalize.c | 113 +++++++++++++++++++++++++++++++++++
 2 files changed, 118 insertions(+)
 create mode 100644 gtk/tests/objects-finalize.c

diff --git a/gtk/tests/Makefile.am b/gtk/tests/Makefile.am
index fb573686c8..ba24328fa5 100644
--- a/gtk/tests/Makefile.am
+++ b/gtk/tests/Makefile.am
@@ -160,6 +160,11 @@ TEST_PROGS			+= gtkmenu
 gtkmenu_SOURCES			 = gtkmenu.c
 gtkmenu_LDADD			 = $(progs_ldadd)
 
+
+TEST_PROGS			+= objects-finalize
+objects_finalize_SOURCES         = objects-finalize.c
+objects_finalize_LDADD	         = $(progs_ldadd)
+
 EXTRA_DIST +=				\
 	file-chooser-test-dir/empty     \
 	file-chooser-test-dir/text.txt
diff --git a/gtk/tests/objects-finalize.c b/gtk/tests/objects-finalize.c
new file mode 100644
index 0000000000..ab69f9ca67
--- /dev/null
+++ b/gtk/tests/objects-finalize.c
@@ -0,0 +1,113 @@
+/* objects-finalize.c
+ * Copyright (C) 2013 Openismus GmbH
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors: Tristan Van Berkom <tristanvb@openismus.com>
+ */
+#include <gtk/gtk.h>
+#include <string.h>
+
+#ifdef GDK_WINDOWING_X11
+# include <gdk/gdkx.h>
+#endif
+
+
+typedef GType (*GTypeGetFunc) (void);
+
+static gboolean
+main_loop_quit_cb (gpointer data)
+{
+  gtk_main_quit ();
+
+  return FALSE;
+}
+
+static void
+check_finalized (gpointer data,
+		 GObject *where_the_object_was)
+{
+  gboolean *did_finalize = (gboolean *)data;
+
+  *did_finalize = TRUE;
+}
+
+static void
+test_finalize_object (gconstpointer data)
+{
+  GType test_type = GPOINTER_TO_SIZE (data);
+  GObject *object;
+  gboolean finalized = FALSE;
+
+  object = g_object_new (test_type, NULL);
+  g_assert (G_IS_OBJECT (object));
+
+  /* Make sure we have the only reference */
+  if (g_object_is_floating (object))
+    g_object_ref_sink (object);
+
+  /* Assert that the object finalizes properly */
+  g_object_weak_ref (object, check_finalized, &finalized);
+
+  /* Toplevels are owned by GTK+, just tell GTK+ to destroy it */
+  if (GTK_IS_WINDOW (object))
+    gtk_widget_destroy (GTK_WIDGET (object));
+  else
+    g_object_unref (object);
+
+  g_assert (finalized);
+
+  /* Even if the object did finalize, it may have left some dangerous stuff in the GMainContext */
+  g_timeout_add (50, main_loop_quit_cb, NULL);
+  gtk_main();
+}
+
+int
+main (int argc, char **argv)
+{
+  const GType *all_types;
+  guint n_types = 0, i;
+
+  /* initialize test program */
+  gtk_test_init (&argc, &argv);
+  gtk_test_register_all_types ();
+
+  all_types = gtk_test_list_all_types (&n_types);
+
+  for (i = 0; i < n_types; i++)
+    {
+      if (g_type_is_a (all_types[i], G_TYPE_OBJECT) &&
+	  G_TYPE_IS_INSTANTIATABLE (all_types[i]) &&
+	  !G_TYPE_IS_ABSTRACT (all_types[i]) &&
+#ifdef GDK_WINDOWING_X11
+	  all_types[i] != GDK_TYPE_X11_WINDOW &&
+	  all_types[i] != GDK_TYPE_X11_CURSOR &&
+	  all_types[i] != GDK_TYPE_X11_SCREEN &&
+	  all_types[i] != GDK_TYPE_X11_DISPLAY &&
+	  all_types[i] != GDK_TYPE_X11_DEVICE_MANAGER_XI2 &&
+	  all_types[i] != GDK_TYPE_X11_DISPLAY_MANAGER &&
+#endif
+	  /* Not allowed to finalize a GdkPixbufLoader without calling gdk_pixbuf_loader_close() */
+	  all_types[i] != GDK_TYPE_PIXBUF_LOADER)
+	{
+	  gchar *test_path = g_strdup_printf ("/FinalizeObject/%s", g_type_name (all_types[i]));
+
+	  g_test_add_data_func (test_path, GSIZE_TO_POINTER (all_types[i]), test_finalize_object);
+
+	  g_free (test_path);
+	}
+    }
+
+  return g_test_run();
+}