gobject/gclosure.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 2000-2001 Red Hat, Inc.
   3  * Copyright (C) 2005 Imendio AB
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  21 #error "Only <glib-object.h> can be included directly."
  22 #endif
  23
  24 #ifndef __G_CLOSURE_H__
  25 #define __G_CLOSURE_H__
  26
  27 #include        <gobject/gtype.h>
  28
  29 G_BEGIN_DECLS
  30
  31 /* --- defines --- */
  32 /**
  33  * G_CLOSURE_NEEDS_MARSHAL:
  34  * @closure: a #GClosure
  35  *
  36  * Check if the closure still needs a marshaller. See g_closure_set_marshal().
  37  *
  38  * Returns: %TRUE if a #GClosureMarshal marshaller has not yet been set on
  39  * @closure.
  40  */
  41 #define G_CLOSURE_NEEDS_MARSHAL(closure) (((GClosure*) (closure))->marshal == NULL)
  42 /**
  43  * G_CLOSURE_N_NOTIFIERS:
  44  * @cl: a #GClosure
  45  *
  46  * Get the total number of notifiers connected with the closure @cl.
  47  * The count includes the meta marshaller, the finalize and invalidate notifiers
  48  * and the marshal guards. Note that each guard counts as two notifiers.
  49  * See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(),
  50  * g_closure_add_invalidate_notifier() and g_closure_add_marshal_guards().
  51  *
  52  * Returns: number of notifiers
  53  */
  54 #define G_CLOSURE_N_NOTIFIERS(cl)        (((cl)->n_guards << 1L) + \
  55                                           (cl)->n_fnotifiers + (cl)->n_inotifiers)
  56 /**
  57  * G_CCLOSURE_SWAP_DATA:
  58  * @cclosure: a #GCClosure
  59  *
  60  * Checks whether the user data of the #GCClosure should be passed as the
  61  * first parameter to the callback. See g_cclosure_new_swap().
  62  *
  63  * Returns: %TRUE if data has to be swapped.
  64  */
  65 #define G_CCLOSURE_SWAP_DATA(cclosure)   (((GClosure*) (cclosure))->derivative_flag)
  66 /**
  67  * G_CALLBACK:
  68  * @f: a function pointer.
  69  *
  70  * Cast a function pointer to a #GCallback.
  71  */
  72 #define G_CALLBACK(f)                    ((GCallback) (f))
  73
  74
  75 /* -- typedefs --- */
  76 typedef struct _GClosure                 GClosure;
  77 typedef struct _GClosureNotifyData       GClosureNotifyData;
  78
  79 /**
  80  * GCallback:
  81  *
  82  * The type used for callback functions in structure definitions and function
  83  * signatures. This doesn't mean that all callback functions must take no
  84  * parameters and return void. The required signature of a callback function
  85  * is determined by the context in which is used (e.g. the signal to which it
  86  * is connected). Use G_CALLBACK() to cast the callback function to a #GCallback.
  87  */
  88 typedef void  (*GCallback)              (void);
  89 /**
  90  * GClosureNotify:
  91  * @data: data specified when registering the notification callback
  92  * @closure: the #GClosure on which the notification is emitted
  93  *
  94  * The type used for the various notification callbacks which can be registered
  95  * on closures.
  96  */
  97 typedef void  (*GClosureNotify)         (gpointer        data,
  98                                          GClosure       *closure);
  99 /**
 100  * GClosureMarshal:
 101  * @closure: the #GClosure to which the marshaller belongs
 102  * @return_value: (allow-none): a #GValue to store the return
 103  *  value. May be %NULL if the callback of @closure doesn't return a
 104  *  value.
 105  * @n_param_values: the length of the @param_values array
 106  * @param_values: (array length=n_param_values): an array of
 107  *  #GValue<!-- -->s holding the arguments on which to invoke the
 108  *  callback of @closure
 109  * @invocation_hint: (allow-none): the invocation hint given as the
 110  *  last argument to g_closure_invoke()
 111  * @marshal_data: (allow-none): additional data specified when
 112  *  registering the marshaller, see g_closure_set_marshal() and
 113  *  g_closure_set_meta_marshal()
 114  *
 115  * The type used for marshaller functions.
 116  */
 117 typedef void  (*GClosureMarshal)        (GClosure       *closure,
 118                                          GValue         *return_value,
 119                                          guint           n_param_values,
 120                                          const GValue   *param_values,
 121                                          gpointer        invocation_hint,
 122                                          gpointer        marshal_data);
 123 /**
 124  * GCClosure:
 125  * @closure: the #GClosure
 126  * @callback: the callback function
 127  *
 128  * A #GCClosure is a specialization of #GClosure for C function callbacks.
 129  */
 130 typedef struct _GCClosure                GCClosure;
 131
 132
 133 /* --- structures --- */
 134 struct _GClosureNotifyData
 135 {
 136   gpointer       data;
 137   GClosureNotify notify;
 138 };
 139 /**
 140  * GClosure:
 141  * @in_marshal: Indicates whether the closure is currently being invoked with
 142  *  g_closure_invoke()
 143  * @is_invalid: Indicates whether the closure has been invalidated by
 144  *  g_closure_invalidate()
 145  *
 146  * A #GClosure represents a callback supplied by the programmer.
 147  */
 148 struct _GClosure
 149 {
 150   /*< private >*/
 151   volatile              guint    ref_count : 15;
 152   /* meta_marshal is not used anymore but must be zero for historical reasons
 153      as it was exposed in the G_CLOSURE_N_NOTIFIERS macro */
 154   volatile              guint    meta_marshal_nouse : 1;
 155   volatile              guint    n_guards : 1;
 156   volatile              guint    n_fnotifiers : 2;      /* finalization notifiers */
 157   volatile              guint    n_inotifiers : 8;      /* invalidation notifiers */
 158   volatile              guint    in_inotify : 1;
 159   volatile              guint    floating : 1;
 160   /*< protected >*/
 161   volatile              guint    derivative_flag : 1;
 162   /*< public >*/
 163   volatile              guint    in_marshal : 1;
 164   volatile              guint    is_invalid : 1;
 165
 166   /*< private >*/       void   (*marshal)  (GClosure       *closure,
 167                                             GValue /*out*/ *return_value,
 168                                             guint           n_param_values,
 169                                             const GValue   *param_values,
 170                                             gpointer        invocation_hint,
 171                                             gpointer        marshal_data);
 172   /*< protected >*/     gpointer data;
 173
 174   /*< private >*/       GClosureNotifyData *notifiers;
 175
 176   /* invariants/constrains:
 177    * - ->marshal and ->data are _invalid_ as soon as ->is_invalid==TRUE
 178    * - invocation of all inotifiers occours prior to fnotifiers
 179    * - order of inotifiers is random
 180    *   inotifiers may _not_ free/invalidate parameter values (e.g. ->data)
 181    * - order of fnotifiers is random
 182    * - each notifier may only be removed before or during its invocation
 183    * - reference counting may only happen prior to fnotify invocation
 184    *   (in that sense, fnotifiers are really finalization handlers)
 185    */
 186 };
 187 /* closure for C function calls, callback() is the user function
 188  */
 189 struct _GCClosure
 190 {
 191   GClosure      closure;
 192   gpointer      callback;
 193 };
 194
 195
 196 /* --- prototypes --- */
 197 GClosure* g_cclosure_new                        (GCallback      callback_func,
 198                                                  gpointer       user_data,
 199                                                  GClosureNotify destroy_data);
 200 GClosure* g_cclosure_new_swap                   (GCallback      callback_func,
 201                                                  gpointer       user_data,
 202                                                  GClosureNotify destroy_data);
 203 GClosure* g_signal_type_cclosure_new            (GType          itype,
 204                                                  guint          struct_offset);
 205
 206
 207 /* --- prototypes --- */
 208 GClosure* g_closure_ref                         (GClosure       *closure);
 209 void      g_closure_sink                        (GClosure       *closure);
 210 void      g_closure_unref                       (GClosure       *closure);
 211 /* intimidating */
 212 GClosure* g_closure_new_simple                  (guint           sizeof_closure,
 213                                                  gpointer        data);
 214 void      g_closure_add_finalize_notifier       (GClosure       *closure,
 215                                                  gpointer        notify_data,
 216                                                  GClosureNotify  notify_func);
 217 void      g_closure_remove_finalize_notifier    (GClosure       *closure,
 218                                                  gpointer        notify_data,
 219                                                  GClosureNotify  notify_func);
 220 void      g_closure_add_invalidate_notifier     (GClosure       *closure,
 221                                                  gpointer        notify_data,
 222                                                  GClosureNotify  notify_func);
 223 void      g_closure_remove_invalidate_notifier  (GClosure       *closure,
 224                                                  gpointer        notify_data,
 225                                                  GClosureNotify  notify_func);
 226 void      g_closure_add_marshal_guards          (GClosure       *closure,
 227                                                  gpointer        pre_marshal_data,
 228                                                  GClosureNotify  pre_marshal_notify,
 229                                                  gpointer        post_marshal_data,
 230                                                  GClosureNotify  post_marshal_notify);
 231 void      g_closure_set_marshal                 (GClosure       *closure,
 232                                                  GClosureMarshal marshal);
 233 void      g_closure_set_meta_marshal            (GClosure       *closure,
 234                                                  gpointer        marshal_data,
 235                                                  GClosureMarshal meta_marshal);
 236 void      g_closure_invalidate                  (GClosure       *closure);
 237 void      g_closure_invoke                      (GClosure       *closure,
 238                                                  GValue /*out*/ *return_value,
 239                                                  guint           n_param_values,
 240                                                  const GValue   *param_values,
 241                                                  gpointer        invocation_hint);
 242
 243 /* FIXME:
 244    OK:  data_object::destroy            -> closure_invalidate();
 245    MIS: closure_invalidate()            -> disconnect(closure);
 246    MIS: disconnect(closure)             -> (unlink) closure_unref();
 247    OK:  closure_finalize()              -> g_free (data_string);
 248
 249    random remarks:
 250    - need marshaller repo with decent aliasing to base types
 251    - provide marshaller collection, virtually covering anything out there
 252 */
 253
 254 void g_cclosure_marshal_generic (GClosure     *closure,
 255                                  GValue       *return_gvalue,
 256                                  guint         n_param_values,
 257                                  const GValue *param_values,
 258                                  gpointer      invocation_hint,
 259                                  gpointer      marshal_data);
 260
 261 G_END_DECLS
 262
 263 #endif /* __G_CLOSURE_H__ */