[gtk+/wip/no-more-gdk-threads: 4/4] Remove all gdk_threads_* entry points

[Emmanuele Bassi <ebassi src gnome org>]

commit eed3e219d39b073e338ad8df3b2637b862e51700
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Feb 2 17:02:59 2018 +0100

    Remove all gdk_threads_* entry points
    
    Now that we don't use them anywhere, it's time for them to go.

 gdk/gdk.c        |  400 +-----------------------------------------------------
 gdk/gdk.h        |    1 -
 gdk/gdkthreads.h |  109 ---------------
 gdk/meson.build  |    1 -
 4 files changed, 2 insertions(+), 509 deletions(-)
---
diff --git a/gdk/gdk.c b/gdk/gdk.c
index 0b18785..6bce57c 100644
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -130,11 +130,6 @@ static int gdk_initialized = 0;                     /* 1 if the library is initi
                                                      * 0 otherwise.
                                                      */
 
-static GMutex gdk_threads_mutex;
-
-static GCallback gdk_threads_lock = NULL;
-static GCallback gdk_threads_unlock = NULL;
-
 #ifdef G_ENABLE_DEBUG
 static const GDebugKey gdk_debug_keys[] = {
   { "misc",            GDK_DEBUG_MISC },
@@ -243,7 +238,7 @@ gdk_display_open_default (void)
  * emitted in the main thread.
  *
  * You can schedule work in the main thread safely from other threads
- * by using gdk_threads_add_idle() and gdk_threads_add_timeout():
+ * by using g_main_context_invoke(), g_idle_add(), and g_timeout_add():
  *
  * |[<!-- language="C" -->
  * static void
@@ -251,7 +246,7 @@ gdk_display_open_default (void)
  * {
  *   ExpensiveData *expensive_data = do_expensive_computation ();
  *
- *   gdk_threads_add_idle (got_value, expensive_data);
+ *   g_main_context_invoke (NULL, got_value, expensive_data);
  * }
  *
  * static gboolean
@@ -267,399 +262,8 @@ gdk_display_open_default (void)
  * }
  * ]|
  *
- * You should use gdk_threads_add_idle() and gdk_threads_add_timeout()
- * instead of g_idle_add() and g_timeout_add() since libraries not under
- * your control might be using the deprecated GDK locking mechanism.
- * If you are sure that none of the code in your application and libraries
- * use the deprecated gdk_threads_enter() or gdk_threads_leave() methods,
- * then you can safely use g_idle_add() and g_timeout_add().
- *
  * For more information on this "worker thread" pattern, you should
  * also look at #GTask, which gives you high-level tools to perform
  * expensive tasks from worker threads, and will handle thread
  * management for you.
  */
-
-
-/**
- * gdk_threads_enter:
- *
- * This function marks the beginning of a critical section in which
- * GDK and GTK+ functions can be called safely and without causing race
- * conditions. Only one thread at a time can be in such a critial
- * section.
- *
- * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
- *     thread
- */
-void
-gdk_threads_enter (void)
-{
-  if (gdk_threads_lock)
-    (*gdk_threads_lock) ();
-}
-
-/**
- * gdk_threads_leave:
- *
- * Leaves a critical region begun with gdk_threads_enter().
- *
- * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
- *     thread
- */
-void
-gdk_threads_leave (void)
-{
-  if (gdk_threads_unlock)
-    (*gdk_threads_unlock) ();
-}
-
-static void
-gdk_threads_impl_lock (void)
-{
-  g_mutex_lock (&gdk_threads_mutex);
-}
-
-static void
-gdk_threads_impl_unlock (void)
-{
-  /* we need a trylock() here because trying to unlock a mutex
-   * that hasn't been locked yet is:
-   *
-   *  a) not portable
-   *  b) fail on GLib ≥ 2.41
-   *
-   * trylock() will either succeed because nothing is holding the
-   * GDK mutex, and will be unlocked right afterwards; or it's
-   * going to fail because the mutex is locked already, in which
-   * case we unlock it as expected.
-   *
-   * this is needed in the case somebody called gdk_threads_init()
-   * without calling gdk_threads_enter() before calling gtk_main().
-   * in theory, we could just say that this is undefined behaviour,
-   * but our documentation has always been *less* than explicit as
-   * to what the behaviour should actually be.
-   *
-   * see bug: https://bugzilla.gnome.org/show_bug.cgi?id=735428
-   */
-  g_mutex_trylock (&gdk_threads_mutex);
-  g_mutex_unlock (&gdk_threads_mutex);
-}
-
-/**
- * gdk_threads_init:
- *
- * Initializes GDK so that it can be used from multiple threads
- * in conjunction with gdk_threads_enter() and gdk_threads_leave().
- *
- * This call must be made before any use of the main loop from
- * GTK+; to be safe, call it before gtk_init().
- *
- * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
- *     thread
- */
-void
-gdk_threads_init (void)
-{
-  if (!gdk_threads_lock)
-    gdk_threads_lock = gdk_threads_impl_lock;
-  if (!gdk_threads_unlock)
-    gdk_threads_unlock = gdk_threads_impl_unlock;
-}
-
-static gboolean
-gdk_threads_dispatch (gpointer data)
-{
-  GdkThreadsDispatch *dispatch = data;
-  gboolean ret = FALSE;
-
-  gdk_threads_enter ();
-
-  if (!g_source_is_destroyed (g_main_current_source ()))
-    ret = dispatch->func (dispatch->data);
-
-  gdk_threads_leave ();
-
-  return ret;
-}
-
-static void
-gdk_threads_dispatch_free (gpointer data)
-{
-  GdkThreadsDispatch *dispatch = data;
-
-  if (dispatch->destroy && dispatch->data)
-    dispatch->destroy (dispatch->data);
-
-  g_slice_free (GdkThreadsDispatch, data);
-}
-
-
-/**
- * gdk_threads_add_idle_full: (rename-to gdk_threads_add_idle)
- * @priority: the priority of the idle source. Typically this will be in the
- *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
- * @function: function to call
- * @data:     data to pass to @function
- * @notify: (allow-none):   function to call when the idle is removed, or %NULL
- *
- * Adds a function to be called whenever there are no higher priority
- * events pending.  If the function returns %FALSE it is automatically
- * removed from the list of event sources and will not be called again.
- *
- * This variant of g_idle_add_full() calls @function with the GDK lock
- * held. It can be thought of a MT-safe version for GTK+ widgets for the
- * following use case, where you have to worry about idle_callback()
- * running in thread A and accessing @self after it has been finalized
- * in thread B:
- *
- * |[<!-- language="C" -->
- * static gboolean
- * idle_callback (gpointer data)
- * {
- *    // gdk_threads_enter(); would be needed for g_idle_add()
- *
- *    SomeWidget *self = data;
- *    // do stuff with self
- *
- *    self->idle_id = 0;
- *
- *    // gdk_threads_leave(); would be needed for g_idle_add()
- *    return FALSE;
- * }
- *
- * static void
- * some_widget_do_stuff_later (SomeWidget *self)
- * {
- *    self->idle_id = gdk_threads_add_idle (idle_callback, self)
- *    // using g_idle_add() here would require thread protection in the callback
- * }
- *
- * static void
- * some_widget_finalize (GObject *object)
- * {
- *    SomeWidget *self = SOME_WIDGET (object);
- *    if (self->idle_id)
- *      g_source_remove (self->idle_id);
- *    G_OBJECT_CLASS (parent_class)->finalize (object);
- * }
- * ]|
- *
- * Returns: the ID (greater than 0) of the event source.
- *
- * Since: 2.12
- */
-guint
-gdk_threads_add_idle_full (gint           priority,
-                           GSourceFunc    function,
-                           gpointer       data,
-                           GDestroyNotify notify)
-{
-  GdkThreadsDispatch *dispatch;
-
-  g_return_val_if_fail (function != NULL, 0);
-
-  dispatch = g_slice_new (GdkThreadsDispatch);
-  dispatch->func = function;
-  dispatch->data = data;
-  dispatch->destroy = notify;
-
-  return g_idle_add_full (priority,
-                          gdk_threads_dispatch,
-                          dispatch,
-                          gdk_threads_dispatch_free);
-}
-
-/**
- * gdk_threads_add_idle: (skip)
- * @function: function to call
- * @data:     data to pass to @function
- *
- * A wrapper for the common usage of gdk_threads_add_idle_full() 
- * assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
- *
- * See gdk_threads_add_idle_full().
- *
- * Returns: the ID (greater than 0) of the event source.
- * 
- * Since: 2.12
- */
-guint
-gdk_threads_add_idle (GSourceFunc    function,
-                      gpointer       data)
-{
-  return gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
-                                    function, data, NULL);
-}
-
-
-/**
- * gdk_threads_add_timeout_full: (rename-to gdk_threads_add_timeout)
- * @priority: the priority of the timeout source. Typically this will be in the
- *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
- * @interval: the time between calls to the function, in milliseconds
- *             (1/1000ths of a second)
- * @function: function to call
- * @data:     data to pass to @function
- * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
- *
- * Sets a function to be called at regular intervals holding the GDK lock,
- * with the given priority.  The function is called repeatedly until it 
- * returns %FALSE, at which point the timeout is automatically destroyed 
- * and the function will not be called again.  The @notify function is
- * called when the timeout is destroyed.  The first call to the
- * function will be at the end of the first @interval.
- *
- * Note that timeout functions may be delayed, due to the processing of other
- * event sources. Thus they should not be relied on for precise timing.
- * After each call to the timeout function, the time of the next
- * timeout is recalculated based on the current time and the given interval
- * (it does not try to “catch up” time lost in delays).
- *
- * This variant of g_timeout_add_full() can be thought of a MT-safe version 
- * for GTK+ widgets for the following use case:
- *
- * |[<!-- language="C" -->
- * static gboolean timeout_callback (gpointer data)
- * {
- *    SomeWidget *self = data;
- *    
- *    // do stuff with self
- *    
- *    self->timeout_id = 0;
- *    
- *    return G_SOURCE_REMOVE;
- * }
- *  
- * static void some_widget_do_stuff_later (SomeWidget *self)
- * {
- *    self->timeout_id = g_timeout_add (timeout_callback, self)
- * }
- *  
- * static void some_widget_finalize (GObject *object)
- * {
- *    SomeWidget *self = SOME_WIDGET (object);
- *    
- *    if (self->timeout_id)
- *      g_source_remove (self->timeout_id);
- *    
- *    G_OBJECT_CLASS (parent_class)->finalize (object);
- * }
- * ]|
- *
- * Returns: the ID (greater than 0) of the event source.
- * 
- * Since: 2.12
- */
-guint
-gdk_threads_add_timeout_full (gint           priority,
-                              guint          interval,
-                              GSourceFunc    function,
-                              gpointer       data,
-                              GDestroyNotify notify)
-{
-  GdkThreadsDispatch *dispatch;
-
-  g_return_val_if_fail (function != NULL, 0);
-
-  dispatch = g_slice_new (GdkThreadsDispatch);
-  dispatch->func = function;
-  dispatch->data = data;
-  dispatch->destroy = notify;
-
-  return g_timeout_add_full (priority, 
-                             interval,
-                             gdk_threads_dispatch, 
-                             dispatch, 
-                             gdk_threads_dispatch_free);
-}
-
-/**
- * gdk_threads_add_timeout: (skip)
- * @interval: the time between calls to the function, in milliseconds
- *             (1/1000ths of a second)
- * @function: function to call
- * @data:     data to pass to @function
- *
- * A wrapper for the common usage of gdk_threads_add_timeout_full() 
- * assigning the default priority, #G_PRIORITY_DEFAULT.
- *
- * See gdk_threads_add_timeout_full().
- * 
- * Returns: the ID (greater than 0) of the event source.
- *
- * Since: 2.12
- */
-guint
-gdk_threads_add_timeout (guint       interval,
-                         GSourceFunc function,
-                         gpointer    data)
-{
-  return gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
-                                       interval, function, data, NULL);
-}
-
-
-/**
- * gdk_threads_add_timeout_seconds_full: (rename-to gdk_threads_add_timeout_seconds)
- * @priority: the priority of the timeout source. Typically this will be in the
- *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
- * @interval: the time between calls to the function, in seconds
- * @function: function to call
- * @data:     data to pass to @function
- * @notify: (allow-none): function to call when the timeout is removed, or %NULL
- *
- * A variant of gdk_threads_add_timeout_full() with second-granularity.
- * See g_timeout_add_seconds_full() for a discussion of why it is
- * a good idea to use this function if you don’t need finer granularity.
- *
- * Returns: the ID (greater than 0) of the event source.
- * 
- * Since: 2.14
- */
-guint
-gdk_threads_add_timeout_seconds_full (gint           priority,
-                                      guint          interval,
-                                      GSourceFunc    function,
-                                      gpointer       data,
-                                      GDestroyNotify notify)
-{
-  GdkThreadsDispatch *dispatch;
-
-  g_return_val_if_fail (function != NULL, 0);
-
-  dispatch = g_slice_new (GdkThreadsDispatch);
-  dispatch->func = function;
-  dispatch->data = data;
-  dispatch->destroy = notify;
-
-  return g_timeout_add_seconds_full (priority, 
-                                     interval,
-                                     gdk_threads_dispatch, 
-                                     dispatch, 
-                                     gdk_threads_dispatch_free);
-}
-
-/**
- * gdk_threads_add_timeout_seconds: (skip)
- * @interval: the time between calls to the function, in seconds
- * @function: function to call
- * @data:     data to pass to @function
- *
- * A wrapper for the common usage of gdk_threads_add_timeout_seconds_full() 
- * assigning the default priority, #G_PRIORITY_DEFAULT.
- *
- * For details, see gdk_threads_add_timeout_full().
- * 
- * Returns: the ID (greater than 0) of the event source.
- *
- * Since: 2.14
- */
-guint
-gdk_threads_add_timeout_seconds (guint       interval,
-                                 GSourceFunc function,
-                                 gpointer    data)
-{
-  return gdk_threads_add_timeout_seconds_full (G_PRIORITY_DEFAULT,
-                                               interval, function, data, NULL);
-}
diff --git a/gdk/gdk.h b/gdk/gdk.h
index 1515ad4..d1ee1b5 100644
--- a/gdk/gdk.h
+++ b/gdk/gdk.h
@@ -61,7 +61,6 @@
 #include <gdk/gdkrgba.h>
 #include <gdk/gdkseat.h>
 #include <gdk/gdktexture.h>
-#include <gdk/gdkthreads.h>
 #include <gdk/gdktypes.h>
 #include <gdk/gdkvulkancontext.h>
 #include <gdk/gdkwindow.h>
diff --git a/gdk/meson.build b/gdk/meson.build
index 10a4f64..7ddb6d4 100644
--- a/gdk/meson.build
+++ b/gdk/meson.build
@@ -75,7 +75,6 @@ gdk_public_headers = files([
   'gdkrectangle.h',
   'gdkrgba.h',
   'gdkseat.h',
-  'gdkthreads.h',
   'gdktexture.h',
   'gdktypes.h',
   'gdkvulkancontext.h',