glib/deprecated/gthread.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_DEPRECATED_THREAD_H__
  32 #define __G_DEPRECATED_THREAD_H__
  33
  34 #include <glib/gthread.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef enum
  39 {
  40   G_THREAD_PRIORITY_LOW,
  41   G_THREAD_PRIORITY_NORMAL,
  42   G_THREAD_PRIORITY_HIGH,
  43   G_THREAD_PRIORITY_URGENT
  44 } GThreadPriority;
  45
  46 struct  _GThread
  47 {
  48   /*< private >*/
  49   GThreadFunc func;
  50   gpointer data;
  51   gboolean joinable;
  52   GThreadPriority priority;
  53 };
  54
  55 typedef struct _GThreadFunctions GThreadFunctions;
  56 struct _GThreadFunctions
  57 {
  58   GMutex*  (*mutex_new)           (void);
  59   void     (*mutex_lock)          (GMutex               *mutex);
  60   gboolean (*mutex_trylock)       (GMutex               *mutex);
  61   void     (*mutex_unlock)        (GMutex               *mutex);
  62   void     (*mutex_free)          (GMutex               *mutex);
  63   GCond*   (*cond_new)            (void);
  64   void     (*cond_signal)         (GCond                *cond);
  65   void     (*cond_broadcast)      (GCond                *cond);
  66   void     (*cond_wait)           (GCond                *cond,
  67                                    GMutex               *mutex);
  68   gboolean (*cond_timed_wait)     (GCond                *cond,
  69                                    GMutex               *mutex,
  70                                    GTimeVal             *end_time);
  71   void      (*cond_free)          (GCond                *cond);
  72   GPrivate* (*private_new)        (GDestroyNotify        destructor);
  73   gpointer  (*private_get)        (GPrivate             *private_key);
  74   void      (*private_set)        (GPrivate             *private_key,
  75                                    gpointer              data);
  76   void      (*thread_create)      (GThreadFunc           func,
  77                                    gpointer              data,
  78                                    gulong                stack_size,
  79                                    gboolean              joinable,
  80                                    gboolean              bound,
  81                                    GThreadPriority       priority,
  82                                    gpointer              thread,
  83                                    GError              **error);
  84   void      (*thread_yield)       (void);
  85   void      (*thread_join)        (gpointer              thread);
  86   void      (*thread_exit)        (void);
  87   void      (*thread_set_priority)(gpointer              thread,
  88                                    GThreadPriority       priority);
  89   void      (*thread_self)        (gpointer              thread);
  90   gboolean  (*thread_equal)       (gpointer              thread1,
  91                                    gpointer              thread2);
  92 };
  93
  94 GLIB_VAR GThreadFunctions       g_thread_functions_for_glib_use;
  95 GLIB_VAR gboolean               g_thread_use_default_impl;
  96
  97 GLIB_VAR guint64   (*g_thread_gettime) (void);
  98
  99 /* internal function for fallback static mutex implementation */
 100 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
 101
 102 GThread* g_thread_create_full  (GThreadFunc            func,
 103                                 gpointer               data,
 104                                 gulong                 stack_size,
 105                                 gboolean               joinable,
 106                                 gboolean               bound,
 107                                 GThreadPriority        priority,
 108                                 GError               **error);
 109
 110 void g_thread_set_priority     (GThread         *thread,
 111                                 GThreadPriority  priority);
 112
 113 #ifdef G_OS_WIN32
 114 typedef GMutex * GStaticMutex;
 115 #define G_STATIC_MUTEX_INIT NULL
 116 #define g_static_mutex_get_mutex g_static_mutex_get_mutex_impl
 117 #else /* G_OS_WIN32 */
 118 typedef struct {
 119   struct _GMutex *unused;
 120   GMutex mutex;
 121 } GStaticMutex;
 122 #define G_STATIC_MUTEX_INIT { NULL, G_MUTEX_INIT }
 123 #define g_static_mutex_get_mutex(s) (&(s)->mutex)
 124 #endif /* G_OS_WIN32 */
 125
 126 #define g_static_mutex_lock(mutex) \
 127     g_mutex_lock (g_static_mutex_get_mutex (mutex))
 128 #define g_static_mutex_trylock(mutex) \
 129     g_mutex_trylock (g_static_mutex_get_mutex (mutex))
 130 #define g_static_mutex_unlock(mutex) \
 131     g_mutex_unlock (g_static_mutex_get_mutex (mutex))
 132 void g_static_mutex_init (GStaticMutex *mutex);
 133 void g_static_mutex_free (GStaticMutex *mutex);
 134
 135 typedef struct _GStaticRecMutex GStaticRecMutex;
 136 struct _GStaticRecMutex
 137 {
 138   /*< private >*/
 139   GStaticMutex mutex;
 140   guint depth;
 141   GSystemThread owner;
 142 };
 143
 144 #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT, 0, {{0, 0, 0, 0}} }
 145 void     g_static_rec_mutex_init        (GStaticRecMutex *mutex);
 146 void     g_static_rec_mutex_lock        (GStaticRecMutex *mutex);
 147 gboolean g_static_rec_mutex_trylock     (GStaticRecMutex *mutex);
 148 void     g_static_rec_mutex_unlock      (GStaticRecMutex *mutex);
 149 void     g_static_rec_mutex_lock_full   (GStaticRecMutex *mutex,
 150                                          guint            depth);
 151 guint    g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex);
 152 void     g_static_rec_mutex_free        (GStaticRecMutex *mutex);
 153
 154 typedef struct _GStaticRWLock GStaticRWLock;
 155 struct _GStaticRWLock
 156 {
 157   /*< private >*/
 158   GStaticMutex mutex;
 159   GCond *read_cond;
 160   GCond *write_cond;
 161   guint read_counter;
 162   gboolean have_writer;
 163   guint want_to_read;
 164   guint want_to_write;
 165 };
 166
 167 #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 }
 168
 169 void      g_static_rw_lock_init           (GStaticRWLock* lock);
 170 void      g_static_rw_lock_reader_lock    (GStaticRWLock* lock);
 171 gboolean  g_static_rw_lock_reader_trylock (GStaticRWLock* lock);
 172 void      g_static_rw_lock_reader_unlock  (GStaticRWLock* lock);
 173 void      g_static_rw_lock_writer_lock    (GStaticRWLock* lock);
 174 gboolean  g_static_rw_lock_writer_trylock (GStaticRWLock* lock);
 175 void      g_static_rw_lock_writer_unlock  (GStaticRWLock* lock);
 176 void      g_static_rw_lock_free           (GStaticRWLock* lock);
 177
 178
 179 GPrivate *      g_private_new             (GDestroyNotify  notify);
 180
 181 G_END_DECLS
 182
 183 #endif /* __G_DEPRECATED_THREAD_H__ */