luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a (diagnostic) warning for finalized floating objects

Browse Source 
GTK currently checks if a GtkWidget is finalized while still using a
floating reference—i.e. a widget was disposed without any parent
container owning it.

This warning can be useful to identify and trace ownership transfer
issues in libraries using initially unowned floating object types.

To avoid introducing constraints ex post, we can gate this check behind
both the G_ENABLE_DEBUG compile time flag for GLib, and behind the
G_ENABLE_DIAGNOSTIC environment variable run time check.

Fixes: #2489
This commit is contained in:
Emmanuele Bassi 2021-09-14 16:09:22 +01:00
parent f763f2b7cb
commit 6fe0f98360
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
gobject/gobject.c
View File

@ -1180,6 +1180,24 @@ g_object_real_dispose (GObject *object)
g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
}
static gboolean
floating_check (GObject *object)
{
static const char *g_enable_diagnostic = NULL;
if (G_UNLIKELY (g_enable_diagnostic == NULL))
{
g_enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
if (g_enable_diagnostic == NULL)
g_enable_diagnostic = "0";
}
if (g_enable_diagnostic[0] == '1')
return g_object_is_floating (object);
return FALSE;
}
static void
g_object_finalize (GObject *object)
{
@ -1189,6 +1207,17 @@ g_object_finalize (GObject *object)
G_OBJECT_TYPE_NAME (object), object);
}
#ifdef G_ENABLE_DEBUG
if (floating_check (object))
{
g_critical ("A floating object %s %p was finalized. This means that someone\n"
"called g_object_unref() on an object that had only a floating\n"
"reference; the initial floating reference is not owned by anyone\n"
"and must be removed with g_object_ref_sink().",
G_OBJECT_TYPE_NAME (object), object);
}
#endif
g_datalist_clear (&object->qdata);
GOBJECT_IF_DEBUG (OBJECTS,