/* GLIB - Library of useful routines for C programming

 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald

 * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser 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

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/*

 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS

 * file for a list of people on the GLib Team.  See the ChangeLog

 * files for a list of changes.  These files are distributed with

 * GLib at ftp://ftp.gtk.org/pub/gtk/. 

 */

#ifndef __G_THREAD_H__

#define __G_THREAD_H__

#include <_ansi.h>

#include <glib/gerror.h>

#include <glib/gtypes.h>

#include <glib/gatomic.h>  /* for g_atomic_pointer_get */

G_BEGIN_DECLS

/* GLib Thread support

 */

#ifdef __SYMBIAN32__

IMPORT_C  GQuark g_thread_error_quark (void);

#else

extern GQuark g_thread_error_quark (void);

#endif /* __SYMBIAN32__ */

#define G_THREAD_ERROR g_thread_error_quark ()

typedef enum

{

  G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */

} GThreadError;

typedef gpointer (*GThreadFunc) (gpointer data);

typedef enum

{

  G_THREAD_PRIORITY_LOW,

  G_THREAD_PRIORITY_NORMAL,

  G_THREAD_PRIORITY_HIGH,

  G_THREAD_PRIORITY_URGENT

} GThreadPriority;

typedef struct _GThread         GThread;

struct  _GThread

{

  /*< private >*/

  GThreadFunc func;

  gpointer data;

  gboolean joinable;

  GThreadPriority priority;

};

typedef struct _GMutex          GMutex;

typedef struct _GCond           GCond;

typedef struct _GPrivate        GPrivate;

typedef struct _GStaticPrivate  GStaticPrivate;

typedef struct _GThreadFunctions GThreadFunctions;

struct _GThreadFunctions

{

  GMutex*  (*mutex_new)           (void);

  void     (*mutex_lock)          (GMutex               *mutex);

  gboolean (*mutex_trylock)       (GMutex               *mutex);

  void     (*mutex_unlock)        (GMutex               *mutex);

  void     (*mutex_free)          (GMutex               *mutex);

  GCond*   (*cond_new)            (void);

  void     (*cond_signal)         (GCond                *cond);

  void     (*cond_broadcast)      (GCond                *cond);

  void     (*cond_wait)           (GCond                *cond,

                                   GMutex               *mutex);

  gboolean (*cond_timed_wait)     (GCond                *cond,

                                   GMutex               *mutex,

                                   GTimeVal             *end_time);

  void      (*cond_free)          (GCond                *cond);

  GPrivate* (*private_new)        (GDestroyNotify        destructor);

  gpointer  (*private_get)        (GPrivate             *private_key);

  void      (*private_set)        (GPrivate             *private_key,

                                   gpointer              data);

  void      (*thread_create)      (GThreadFunc           func,

                                   gpointer              data,

                                   gulong                stack_size,

                                   gboolean              joinable,

                                   gboolean              bound,

                                   GThreadPriority       priority,

                                   gpointer              thread,

                                   GError              **error);

  void      (*thread_yield)       (void);

  void      (*thread_join)        (gpointer              thread);

  void      (*thread_exit)        (void);

  void      (*thread_set_priority)(gpointer              thread,

                                   GThreadPriority       priority);

  void      (*thread_self)        (gpointer              thread);

  gboolean  (*thread_equal)       (gpointer              thread1,

				   gpointer              thread2);

};

#ifdef __SYMBIAN32__

IMPORT_C GThreadFunctions *_g_thread_functions_for_glib_use();

#endif /* __SYMBIAN32__ */

GLIB_VAR GThreadFunctions       g_thread_functions_for_glib_use;

#ifdef __SYMBIAN32__

IMPORT_C gboolean *_g_thread_use_default_impl();

#endif /* __SYMBIAN32__ */

GLIB_VAR gboolean               g_thread_use_default_impl;

#ifdef __SYMBIAN32__

IMPORT_C gboolean *_g_threads_got_initialized();

#endif /* __SYMBIAN32__ */

GLIB_VAR gboolean               g_threads_got_initialized;

/* initializes the mutex/cond/private implementation for glib, might

 * only be called once, and must not be called directly or indirectly

 * from another glib-function, e.g. as a callback.

 */

IMPORT_C void    g_thread_init   (GThreadFunctions       *vtable);

#ifdef __SYMBIAN32__

IMPORT_C gboolean g_thread_supported();

#else  

#define g_thread_supported()    (g_threads_got_initialized)

#endif

/* Errorcheck mutexes. If you define G_ERRORCHECK_MUTEXES, then all

 * mutexes will check for re-locking and re-unlocking */

/* Initialize thread system with errorcheck mutexes. vtable must be

 * NULL. Do not call directly. Use #define G_ERRORCHECK_MUTEXES

 * instead.

 */

IMPORT_C void    g_thread_init_with_errorcheck_mutexes (GThreadFunctions* vtable);

/* A random number to recognize debug calls to g_mutex_... */

#define G_MUTEX_DEBUG_MAGIC 0xf8e18ad7

#ifdef G_ERRORCHECK_MUTEXES

#define g_thread_init(vtable) g_thread_init_with_errorcheck_mutexes (vtable)

#endif

/* internal function for fallback static mutex implementation */

IMPORT_C GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);

#define g_static_mutex_get_mutex_impl_shortcut(mutex) \

  (g_atomic_pointer_get ((gpointer*)(void*)mutex) ? *(mutex) : \

   g_static_mutex_get_mutex_impl (mutex))

/* shorthands for conditional and unconditional function calls */

#define G_THREAD_UF(op, arglist)					\

    (*g_thread_functions_for_glib_use . op) arglist

#define G_THREAD_CF(op, fail, arg)					\

    (g_thread_supported () ? G_THREAD_UF (op, arg) : (fail))

#define G_THREAD_ECF(op, fail, mutex, type)				\

    (g_thread_supported () ? ((type(*)(GMutex*, gulong, gchar*))	\

      (*g_thread_functions_for_glib_use . op))				\

     (mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (fail))

#ifndef G_ERRORCHECK_MUTEXES

# define g_mutex_lock(mutex)						\

    G_THREAD_CF (mutex_lock,     (void)0, (mutex))

# define g_mutex_trylock(mutex)						\

    G_THREAD_CF (mutex_trylock,  TRUE,    (mutex))

# define g_mutex_unlock(mutex)						\

    G_THREAD_CF (mutex_unlock,   (void)0, (mutex))

# define g_mutex_free(mutex)						\

    G_THREAD_CF (mutex_free,     (void)0, (mutex))

# define g_cond_wait(cond, mutex)					\

    G_THREAD_CF (cond_wait,      (void)0, (cond, mutex))

# define g_cond_timed_wait(cond, mutex, abs_time)			\

    G_THREAD_CF (cond_timed_wait, TRUE,   (cond, mutex, abs_time))

#else /* G_ERRORCHECK_MUTEXES */

# define g_mutex_lock(mutex)						\

    G_THREAD_ECF (mutex_lock,    (void)0, (mutex), void)

# define g_mutex_trylock(mutex)						\

    G_THREAD_ECF (mutex_trylock, TRUE,    (mutex), gboolean)

# define g_mutex_unlock(mutex)						\

    G_THREAD_ECF (mutex_unlock,  (void)0, (mutex), void)

# define g_mutex_free(mutex)						\

    G_THREAD_ECF (mutex_free,    (void)0, (mutex), void)

# define g_cond_wait(cond, mutex)					\

    (g_thread_supported () ? ((void(*)(GCond*, GMutex*, gulong, gchar*))\

      g_thread_functions_for_glib_use.cond_wait)			\

        (cond, mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (void) 0)

# define g_cond_timed_wait(cond, mutex, abs_time)			\

    (g_thread_supported () ?						\

      ((gboolean(*)(GCond*, GMutex*, GTimeVal*, gulong, gchar*))	\

        g_thread_functions_for_glib_use.cond_timed_wait)		\

          (cond, mutex, abs_time, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : TRUE)

#endif /* G_ERRORCHECK_MUTEXES */

#define g_mutex_new()            G_THREAD_UF (mutex_new,      ())

#define g_cond_new()             G_THREAD_UF (cond_new,       ())

#define g_cond_signal(cond)      G_THREAD_CF (cond_signal,    (void)0, (cond))

#define g_cond_broadcast(cond)   G_THREAD_CF (cond_broadcast, (void)0, (cond))

#define g_cond_free(cond)        G_THREAD_CF (cond_free,      (void)0, (cond))

#define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))

#define g_private_get(private_key) G_THREAD_CF (private_get, \

                                                ((gpointer)private_key), \

                                                (private_key))

#define g_private_set(private_key, value) G_THREAD_CF (private_set, \

                                                       (void) (private_key = \

                                                        (GPrivate*) (value)), \

                                                       (private_key, value))

#define g_thread_yield()              G_THREAD_CF (thread_yield, (void)0, ())

#define g_thread_create(func, data, joinable, error)			\

  (g_thread_create_full (func, data, 0, joinable, FALSE, 		\

                         G_THREAD_PRIORITY_NORMAL, error))

IMPORT_C GThread* g_thread_create_full  (GThreadFunc            func,

                                gpointer               data,

                                gulong                 stack_size,

                                gboolean               joinable,

                                gboolean               bound,

                                GThreadPriority        priority,

                                GError               **error);

IMPORT_C GThread* g_thread_self         (void);

IMPORT_C void     g_thread_exit         (gpointer               retval);

IMPORT_C gpointer g_thread_join         (GThread               *thread);

IMPORT_C void     g_thread_set_priority (GThread               *thread,

                                GThreadPriority        priority);

/* GStaticMutexes can be statically initialized with the value

 * G_STATIC_MUTEX_INIT, and then they can directly be used, that is

 * much easier, than having to explicitly allocate the mutex before

 * use

 */

#define g_static_mutex_lock(mutex) \

    g_mutex_lock (g_static_mutex_get_mutex (mutex))

#define g_static_mutex_trylock(mutex) \

    g_mutex_trylock (g_static_mutex_get_mutex (mutex))

#define g_static_mutex_unlock(mutex) \

    g_mutex_unlock (g_static_mutex_get_mutex (mutex))

IMPORT_C void g_static_mutex_init (GStaticMutex *mutex);

IMPORT_C void g_static_mutex_free (GStaticMutex *mutex);

struct _GStaticPrivate

{

  /*< private >*/

  guint index;

};

#define G_STATIC_PRIVATE_INIT { 0 }

IMPORT_C void     g_static_private_init           (GStaticPrivate   *private_key);

IMPORT_C gpointer g_static_private_get            (GStaticPrivate   *private_key);

IMPORT_C void     g_static_private_set            (GStaticPrivate   *private_key,

					  gpointer          data,

					  GDestroyNotify    notify);

IMPORT_C void     g_static_private_free           (GStaticPrivate   *private_key);

typedef struct _GStaticRecMutex GStaticRecMutex;

struct _GStaticRecMutex

{

  /*< private >*/

  GStaticMutex mutex;

  guint depth;

  GSystemThread owner;

};

#define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT }

IMPORT_C void     g_static_rec_mutex_init        (GStaticRecMutex *mutex);

IMPORT_C void     g_static_rec_mutex_lock        (GStaticRecMutex *mutex);

IMPORT_C gboolean g_static_rec_mutex_trylock     (GStaticRecMutex *mutex);

IMPORT_C void     g_static_rec_mutex_unlock      (GStaticRecMutex *mutex);

IMPORT_C void     g_static_rec_mutex_lock_full   (GStaticRecMutex *mutex,

                                         guint            depth);

IMPORT_C guint    g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex);

IMPORT_C void     g_static_rec_mutex_free        (GStaticRecMutex *mutex);

typedef struct _GStaticRWLock GStaticRWLock;

struct _GStaticRWLock

{

  /*< private >*/

  GStaticMutex mutex;

  GCond *read_cond;

  GCond *write_cond;

  guint read_counter;

  gboolean have_writer;

  guint want_to_read;

  guint want_to_write;

};

#define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 }

IMPORT_C void      g_static_rw_lock_init           (GStaticRWLock* lock);

IMPORT_C void      g_static_rw_lock_reader_lock    (GStaticRWLock* lock);

IMPORT_C gboolean  g_static_rw_lock_reader_trylock (GStaticRWLock* lock);

IMPORT_C void      g_static_rw_lock_reader_unlock  (GStaticRWLock* lock);

IMPORT_C void      g_static_rw_lock_writer_lock    (GStaticRWLock* lock);

IMPORT_C gboolean  g_static_rw_lock_writer_trylock (GStaticRWLock* lock);

IMPORT_C void      g_static_rw_lock_writer_unlock  (GStaticRWLock* lock);

IMPORT_C void      g_static_rw_lock_free           (GStaticRWLock* lock);

IMPORT_C void	  g_thread_foreach         	  (GFunc    	  thread_func,

					   gpointer 	  user_data);

typedef enum

{

  G_ONCE_STATUS_NOTCALLED,

  G_ONCE_STATUS_PROGRESS,

  G_ONCE_STATUS_READY  

} GOnceStatus;

typedef struct _GOnce GOnce;

struct _GOnce

{

  volatile GOnceStatus status;

  volatile gpointer retval;

};

#define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }

IMPORT_C gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);

#ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED

# define g_once(once, func, arg) g_once_impl ((once), (func), (arg))

#else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/

# define g_once(once, func, arg) \

  (((once)->status == G_ONCE_STATUS_READY) ? \

   (once)->retval : \

   g_once_impl ((once), (func), (arg)))

#endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */

/* these are some convenience macros that expand to nothing if GLib

 * was configured with --disable-threads. for using StaticMutexes,

 * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name)

 * if you need to export the mutex. With G_LOCK_EXTERN (name) you can

 * declare such an globally defined lock. name is a unique identifier

 * for the protected varibale or code portion. locking, testing and

 * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and

 * G_TRYLOCK() respectively.

 */

 #ifdef __SYMBIAN32__

 #ifdef G_DEBUG_LOCKS

 #undef G_DEBUG_LOCKS

 #endif //G_DEBUG_LOCKS

 #endif //__SYMBIAN32__

extern void glib_dummy_decl (void);

#define G_LOCK_NAME(name)               g__ ## name ## _lock

#ifdef  G_THREADS_ENABLED

#  define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)

#  define G_LOCK_DEFINE(name)           \

    GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT

#  define G_LOCK_EXTERN(name)           extern GStaticMutex G_LOCK_NAME (name)

#  ifdef G_DEBUG_LOCKS

#    define G_LOCK(name)                G_STMT_START{             \

        g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \

               "file %s: line %d (%s): locking: %s ",             \

               __FILE__,        __LINE__, G_GNUC_PRETTY_FUNCTION, \

               #name);                                            \

        g_static_mutex_lock (&G_LOCK_NAME (name));                \

     }G_STMT_END

#    define G_UNLOCK(name)              G_STMT_START{             \

        g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \

               "file %s: line %d (%s): unlocking: %s ",           \

               __FILE__,        __LINE__, G_GNUC_PRETTY_FUNCTION, \

               #name);                                            \

       g_static_mutex_unlock (&G_LOCK_NAME (name));               \

     }G_STMT_END

#    define G_TRYLOCK(name)                                       \

        (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \

               "file %s: line %d (%s): try locking: %s ",         \

               __FILE__,        __LINE__, G_GNUC_PRETTY_FUNCTION, \

               #name), g_static_mutex_trylock (&G_LOCK_NAME (name)))

#  else  /* !G_DEBUG_LOCKS */

#    define G_LOCK(name) g_static_mutex_lock       (&G_LOCK_NAME (name))

#    define G_UNLOCK(name) g_static_mutex_unlock   (&G_LOCK_NAME (name))

#    define G_TRYLOCK(name) g_static_mutex_trylock (&G_LOCK_NAME (name))

#  endif /* !G_DEBUG_LOCKS */

#else   /* !G_THREADS_ENABLED */

#  define G_LOCK_DEFINE_STATIC(name)    extern void glib_dummy_decl (void)

#  define G_LOCK_DEFINE(name)           extern void glib_dummy_decl (void)

#  define G_LOCK_EXTERN(name)           extern void glib_dummy_decl (void)

#  define G_LOCK(name)

#  define G_UNLOCK(name)

#  define G_TRYLOCK(name)               (TRUE)

#endif  /* !G_THREADS_ENABLED */

G_END_DECLS

#endif /* __G_THREAD_H__ */