Add glib__private__() API to share between glib,gio; port GWakeup to it

Historically we've added random symbols to the public API with warnings
that they're private; examples are:

glib_gettext(), glib_pgettext()
g_thread_functions_for_glib_use, g_thread_use_default_impl, etc.

And we almost added "GWakeup" to public API just to share between glib and
gio.

This new glib__private__() API exports a hidden vtable, and adds a macro
GLIB_PRIVATE_CALL() that makes it generally convenient to use.

This adds an extremely tiny cost for the double indirection; but it has
the benefit that we don't need to either:

1) compile the code into both glib and gio (like GWakeup), with the
   inefficiency that implies.
2) Export a "do not use this" symbol; the serious problem with this is
   that someone CAN use it pretty easily.  Particularly if we document
   it.  It's far, far harder to peek into a structure without a public
   header file.

https://bugzilla.gnome.org/show_bug.cgi?id=657992
This commit is contained in:
Colin Walters
2011-09-01 14:32:11 -04:00
committed by Ryan Lortie
parent b891b3616f
commit 9bf59d4a14
6 changed files with 104 additions and 9 deletions

View File

@@ -278,7 +278,6 @@ libgio_2_0_la_SOURCES = \
gasyncresult.c \
gbufferedinputstream.c \
gbufferedoutputstream.c \
../glib/gwakeup.c \
gcancellable.c \
gcontenttype.c \
gcontenttypeprivate.h \

View File

@@ -23,7 +23,7 @@
#include "config.h"
#include "glib.h"
#include <gioerror.h>
#include "gwakeup.h"
#include "glib-private.h"
#include "gcancellable.h"
#include "glibintl.h"
@@ -67,7 +67,7 @@ g_cancellable_finalize (GObject *object)
GCancellable *cancellable = G_CANCELLABLE (object);
if (cancellable->priv->wakeup)
g_wakeup_free (cancellable->priv->wakeup);
GLIB_PRIVATE_CALL (g_wakeup_free) (cancellable->priv->wakeup);
G_OBJECT_CLASS (g_cancellable_parent_class)->finalize (object);
}
@@ -277,7 +277,7 @@ g_cancellable_reset (GCancellable *cancellable)
if (priv->cancelled)
{
if (priv->wakeup)
g_wakeup_acknowledge (priv->wakeup);
GLIB_PRIVATE_CALL (g_wakeup_acknowledge) (priv->wakeup);
priv->cancelled = FALSE;
}
@@ -406,13 +406,13 @@ g_cancellable_make_pollfd (GCancellable *cancellable, GPollFD *pollfd)
if (cancellable->priv->wakeup == NULL)
{
cancellable->priv->wakeup = g_wakeup_new ();
cancellable->priv->wakeup = GLIB_PRIVATE_CALL (g_wakeup_new) ();
if (cancellable->priv->cancelled)
g_wakeup_signal (cancellable->priv->wakeup);
GLIB_PRIVATE_CALL (g_wakeup_signal) (cancellable->priv->wakeup);
}
g_wakeup_get_pollfd (cancellable->priv->wakeup, pollfd);
GLIB_PRIVATE_CALL (g_wakeup_get_pollfd) (cancellable->priv->wakeup, pollfd);
G_UNLOCK(cancellable);
@@ -452,7 +452,7 @@ g_cancellable_release_fd (GCancellable *cancellable)
priv->fd_refcount--;
if (priv->fd_refcount == 0)
{
g_wakeup_free (priv->wakeup);
GLIB_PRIVATE_CALL (g_wakeup_free) (priv->wakeup);
priv->wakeup = NULL;
}
G_UNLOCK (cancellable);
@@ -499,7 +499,7 @@ g_cancellable_cancel (GCancellable *cancellable)
priv->cancelled_running = TRUE;
if (priv->wakeup)
g_wakeup_signal (priv->wakeup);
GLIB_PRIVATE_CALL (g_wakeup_signal) (priv->wakeup);
G_UNLOCK(cancellable);