turned all modifications to the first 32 integer bits in a closure into
[platform/upstream/glib.git] / gobject / gclosure.h
index 2ca0f3f..7a2078d 100644 (file)
@@ -1,5 +1,6 @@
 /* GObject - GLib Type, Object, Parameter and Signal Library
- * Copyright (C) 2000 Red Hat, Inc.
+ * Copyright (C) 2000-2001 Red Hat, Inc.
+ * Copyright (C) 2005 Imendio AB
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
+#error "Only <glib-object.h> can be included directly."
+#endif
+
 #ifndef __G_CLOSURE_H__
 #define __G_CLOSURE_H__
 
-
 #include        <gobject/gtype.h>
 
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-
+G_BEGIN_DECLS
 
 /* --- defines --- */
 #define        G_CLOSURE_NEEDS_MARSHAL(closure) (((GClosure*) (closure))->marshal == NULL)
+#define        G_CLOSURE_N_NOTIFIERS(cl)        ((cl)->meta_marshal + ((cl)->n_guards << 1L) + \
+                                          (cl)->n_fnotifiers + (cl)->n_inotifiers)
 #define        G_CCLOSURE_SWAP_DATA(cclosure)   (((GClosure*) (closure))->derivative_flag)
+#define        G_CALLBACK(f)                    ((GCallback) (f))
 
 
 /* -- typedefs --- */
 typedef struct _GClosure                GClosure;
 typedef struct _GClosureNotifyData      GClosureNotifyData;
-typedef        gpointer GCallback;
+typedef void  (*GCallback)              (void);
 typedef void  (*GClosureNotify)                (gpointer        data,
                                         GClosure       *closure);
 typedef void  (*GClosureMarshal)       (GClosure       *closure,
@@ -57,16 +59,19 @@ struct _GClosureNotifyData
 };
 struct _GClosure
 {
-  /*< private >*/      guint    ref_count : 15;
-  /*< private >*/      guint    meta_marshal : 1;
-  /*< private >*/      guint    n_guards : 1;
-  /*< private >*/      guint    n_fnotifiers : 2;      /* finalization notifiers */
-  /*< private >*/      guint    n_inotifiers : 8;      /* invalidation notifiers */
-  /*< private >*/      guint    in_inotify : 1;
-  /*< private >*/      guint    floating : 1;
-  /*< protected >*/    guint    derivative_flag : 1;
-  /*< puplic >*/       guint    in_marshal : 1;
-  /*< public >*/       guint    is_invalid : 1;
+  /*< private >*/
+  volatile             guint    ref_count : 15;
+  volatile             guint    meta_marshal : 1;
+  volatile             guint    n_guards : 1;
+  volatile             guint    n_fnotifiers : 2;      /* finalization notifiers */
+  volatile             guint    n_inotifiers : 8;      /* invalidation notifiers */
+  volatile             guint    in_inotify : 1;
+  volatile             guint    floating : 1;
+  /*< protected >*/
+  volatile             guint    derivative_flag : 1;
+  /*< public >*/
+  volatile             guint    in_marshal : 1;
+  volatile             guint    is_invalid : 1;
 
   /*< private >*/      void   (*marshal)  (GClosure       *closure,
                                            GValue /*out*/ *return_value,
@@ -84,7 +89,7 @@ struct _GClosure
    * - order of inotifiers is random
    *   inotifiers may _not_ free/invalidate parameter values (e.g. ->data)
    * - order of fnotifiers is random
-   * - notifiers may only be removed before or during their invocation
+   * - each notifier may only be removed before or during its invocation
    * - reference counting may only happen prior to fnotify invocation
    *   (in that sense, fnotifiers are really finalization handlers)
    */
@@ -99,87 +104,63 @@ struct _GCClosure
 
 
 /* --- prototypes --- */
-GClosure*      g_cclosure_new                  (GCallback      callback_func,
+GClosure* g_cclosure_new                       (GCallback      callback_func,
                                                 gpointer       user_data,
                                                 GClosureNotify destroy_data);
-GClosure*      g_cclosure_new_swap             (GCallback      callback_func,
+GClosure* g_cclosure_new_swap                  (GCallback      callback_func,
                                                 gpointer       user_data,
                                                 GClosureNotify destroy_data);
-GClosure*      g_signal_type_closure_new       (GType          itype,
+GClosure* g_signal_type_cclosure_new           (GType          itype,
                                                 guint          struct_offset);
 
 
 /* --- prototypes --- */
-GClosure*      g_closure_ref                   (GClosure       *closure);
-void           g_closure_unref                 (GClosure       *closure);
+GClosure* g_closure_ref                                (GClosure       *closure);
+void     g_closure_sink                        (GClosure       *closure);
+void     g_closure_unref                       (GClosure       *closure);
 /* intimidating */
-GClosure*      g_closure_new_simple            (guint           sizeof_closure,
+GClosure* g_closure_new_simple                 (guint           sizeof_closure,
                                                 gpointer        data);
-void           g_closure_add_fnotify           (GClosure       *closure,
+void     g_closure_add_finalize_notifier       (GClosure       *closure,
                                                 gpointer        notify_data,
                                                 GClosureNotify  notify_func);
-void           g_closure_remove_fnotify        (GClosure       *closure,
+void     g_closure_remove_finalize_notifier    (GClosure       *closure,
                                                 gpointer        notify_data,
                                                 GClosureNotify  notify_func);
-void           g_closure_add_inotify           (GClosure       *closure,
+void     g_closure_add_invalidate_notifier     (GClosure       *closure,
                                                 gpointer        notify_data,
                                                 GClosureNotify  notify_func);
-void           g_closure_remove_inotify        (GClosure       *closure,
+void     g_closure_remove_invalidate_notifier  (GClosure       *closure,
                                                 gpointer        notify_data,
                                                 GClosureNotify  notify_func);
-void           g_closure_add_marshal_guards    (GClosure       *closure,
+void     g_closure_add_marshal_guards          (GClosure       *closure,
                                                 gpointer        pre_marshal_data,
                                                 GClosureNotify  pre_marshal_notify,
                                                 gpointer        post_marshal_data,
                                                 GClosureNotify  post_marshal_notify);
-void           g_closure_set_marshal           (GClosure       *closure,
+void     g_closure_set_marshal                 (GClosure       *closure,
                                                 GClosureMarshal marshal);
-void           g_closure_set_meta_marshal      (GClosure       *closure,
+void     g_closure_set_meta_marshal            (GClosure       *closure,
                                                 gpointer        marshal_data,
                                                 GClosureMarshal meta_marshal);
-void           g_closure_invalidate            (GClosure       *closure);
-void           g_closure_invoke                (GClosure       *closure,
+void     g_closure_invalidate                  (GClosure       *closure);
+void     g_closure_invoke                      (GClosure       *closure,
                                                 GValue /*out*/ *return_value,
                                                 guint           n_param_values,
                                                 const GValue   *param_values,
                                                 gpointer        invocation_hint);
 
+/* FIXME:
+   OK:  data_object::destroy           -> closure_invalidate();
+   MIS:        closure_invalidate()            -> disconnect(closure);
+   MIS:        disconnect(closure)             -> (unlink) closure_unref();
+   OK: closure_finalize()              -> g_free (data_string);
 
-/*
-  data_object::destroy         -> closure_invalidate();
-  closure_invalidate()         -> disconnect(closure);
-  disconnect(closure)          -> (unlink) closure_unref();
-  closure_finalize()           -> g_free (data_string);
-  
-  1) need GObject and GType in glib
-  2) need GParam
-  3) need to resolve dtor cycles
-  4) need GSignal move
-  5) destroy on last caller ref or last data ref?
-  
-  
-  random remarks:
-  - don't mandate signals for GObject
-  - OTOH, don't mandate GObject for GSignal
-  - need marshaller repo with decent aliasing to base types
-  - provide marshaller collection, virtually covering anything out there
-  - at that point, still need GSignalCMarhsaller to g_signal_new() ?
-  - can we combine varargs collect mechanisms with marshaller stubs?
-  for out values (i.e. returntypes), that might get rid of the following
-  point...
-  - char* return signals with connections ala:
-  connect({ return "static data that can't work"; }),
-  connect({ return g_strdup ("properly duplicated string"); })
-  won't work anymore. CRASH
-
-  problems:
-  - accumulator needs gboolean to indicate EMISSION_STOP
-  - accumulator needs data
+   random remarks:
+   - need marshaller repo with decent aliasing to base types
+   - provide marshaller collection, virtually covering anything out there
 */
 
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __G_CLOSURE_H__ */