Pileus Git - ~andy/gtk/blob - gtk/gtksignal.c

   1 /* GTK - The GIMP Toolkit
   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 #include        "gtksignal.h"
  21 #include        "gtkargcollector.c"
  22 #include        "gtkmarshal.c"
  23
  24
  25 /* the real parameter limit is of course given by GSignal, bu we need
  26  * an upper limit for the implementations. so this should be adjusted
  27  * with any future changes on the GSignal side of things.
  28  */
  29 #define SIGNAL_MAX_PARAMS       12
  30
  31
  32 /* --- functions --- */
  33 guint
  34 gtk_signal_newv (const gchar         *name,
  35                  GtkSignalRunType     signal_flags,
  36                  GtkType              object_type,
  37                  guint                function_offset,
  38                  GtkSignalMarshaller  marshaller,
  39                  GtkType              return_val,
  40                  guint                n_params,
  41                  GtkType             *params)
  42 {
  43   GClosure *closure;
  44
  45   g_return_val_if_fail (n_params < SIGNAL_MAX_PARAMS, 0);
  46
  47   closure = g_signal_type_closure_new (object_type, function_offset);
  48
  49   return g_signal_newv (name, object_type, signal_flags, closure, NULL, marshaller, return_val, n_params, params);
  50 }
  51
  52 guint
  53 gtk_signal_new (const gchar         *name,
  54                 GtkSignalRunType     signal_flags,
  55                 GtkType              object_type,
  56                 guint                function_offset,
  57                 GtkSignalMarshaller  marshaller,
  58                 GtkType              return_val,
  59                 guint                n_params,
  60                 ...)
  61 {
  62   GtkType *params;
  63   guint signal_id;
  64
  65   if (n_params)
  66     {
  67       va_list args;
  68       guint i;
  69
  70       params = g_new (GtkType, n_params);
  71       va_start (args, n_params);
  72       for (i = 0; i < n_params; i++)
  73         params[i] = va_arg (args, GtkType);
  74       va_end (args);
  75     }
  76   else
  77     params = NULL;
  78   signal_id = gtk_signal_newv (name,
  79                                signal_flags,
  80                                object_type,
  81                                function_offset,
  82                                marshaller,
  83                                return_val,
  84                                n_params,
  85                                params);
  86   g_free (params);
  87
  88   return signal_id;
  89 }
  90
  91 void
  92 gtk_signal_emit_stop_by_name (GtkObject   *object,
  93                               const gchar *name)
  94 {
  95   g_return_if_fail (GTK_IS_OBJECT (object));
  96
  97   g_signal_stop_emission (object, g_signal_lookup (name, G_OBJECT_TYPE (object)));
  98 }
  99
 100 void
 101 gtk_signal_connect_object_while_alive (GtkObject    *object,
 102                                        const gchar  *signal,
 103                                        GtkSignalFunc func,
 104                                        GtkObject    *alive_object)
 105 {
 106   g_return_if_fail (GTK_IS_OBJECT (object));
 107
 108   g_signal_connect_closure (object,
 109                             g_signal_lookup (signal, G_OBJECT_TYPE (object)),
 110                             g_cclosure_new_object_swap (func, alive_object),
 111                             FALSE);
 112 }
 113
 114 void
 115 gtk_signal_connect_while_alive (GtkObject    *object,
 116                                 const gchar  *signal,
 117                                 GtkSignalFunc func,
 118                                 gpointer      func_data,
 119                                 GtkObject    *alive_object)
 120 {
 121   GClosure *closure;
 122
 123   g_return_if_fail (GTK_IS_OBJECT (object));
 124
 125   closure = g_cclosure_new (func, func_data, NULL);
 126   g_object_watch_closure (G_OBJECT (alive_object), closure);
 127   g_signal_connect_closure (object,
 128                             g_signal_lookup (signal, G_OBJECT_TYPE (object)),
 129                             closure,
 130                             FALSE);
 131 }
 132
 133 guint
 134 gtk_signal_connect_full (GtkObject           *object,
 135                          const gchar         *name,
 136                          GtkSignalFunc        func,
 137                          GtkCallbackMarshal   unsupported,
 138                          gpointer             data,
 139                          GtkDestroyNotify     destroy_func,
 140                          gint                 object_signal,
 141                          gint                 after)
 142 {
 143   g_return_val_if_fail (GTK_IS_OBJECT (object), 0);
 144   g_return_val_if_fail (unsupported == NULL, 0);
 145
 146   return g_signal_connect_closure (object,
 147                                    g_signal_lookup (name, G_OBJECT_TYPE (object)),
 148                                    (object_signal
 149                                     ? g_cclosure_new_swap
 150                                     : g_cclosure_new) (func,
 151                                                        data,
 152                                                        (GClosureNotify) destroy_func),
 153                                    after);
 154 }
 155
 156 void
 157 gtk_signal_compat_matched (GtkObject       *object,
 158                            GtkSignalFunc    func,
 159                            gpointer         data,
 160                            GSignalMatchType match,
 161                            guint            action)
 162 {
 163   guint id;
 164
 165   g_return_if_fail (GTK_IS_OBJECT (object));
 166
 167   id = g_signal_handler_find (object, match, 0, NULL, func, data);
 168
 169   if (!id)
 170     g_warning ("unable to find signal handler for object(%p) with func(%p) and data(%p)",
 171                object, func, data);
 172   else
 173     switch (action)
 174       {
 175       case 0: g_signal_handler_disconnect (object, id); break;
 176       case 1: g_signal_handler_block (object, id);      break;
 177       case 2: g_signal_handler_unblock (object, id);    break;
 178       }
 179 }
 180
 181 static inline gboolean
 182 gtk_arg_to_value (GtkArg *arg,
 183                   GValue *value)
 184 {
 185   switch (G_TYPE_FUNDAMENTAL (arg->type))
 186     {
 187     case G_TYPE_CHAR:           g_value_set_char (value, GTK_VALUE_CHAR (*arg));        break;
 188     case G_TYPE_UCHAR:          g_value_set_uchar (value, GTK_VALUE_UCHAR (*arg));      break;
 189     case G_TYPE_BOOLEAN:        g_value_set_boolean (value, GTK_VALUE_BOOL (*arg));     break;
 190     case G_TYPE_INT:            g_value_set_int (value, GTK_VALUE_INT (*arg));          break;
 191     case G_TYPE_UINT:           g_value_set_uint (value, GTK_VALUE_UINT (*arg));        break;
 192     case G_TYPE_LONG:           g_value_set_long (value, GTK_VALUE_LONG (*arg));        break;
 193     case G_TYPE_ULONG:          g_value_set_ulong (value, GTK_VALUE_ULONG (*arg));      break;
 194     case G_TYPE_ENUM:           g_value_set_enum (value, GTK_VALUE_ENUM (*arg));        break;
 195     case G_TYPE_FLAGS:          g_value_set_flags (value, GTK_VALUE_FLAGS (*arg));      break;
 196     case G_TYPE_FLOAT:          g_value_set_float (value, GTK_VALUE_FLOAT (*arg));      break;
 197     case G_TYPE_DOUBLE:         g_value_set_double (value, GTK_VALUE_DOUBLE (*arg));    break;
 198     case G_TYPE_STRING:         g_value_set_string (value, GTK_VALUE_STRING (*arg));    break;
 199     case G_TYPE_BOXED:          g_value_set_boxed (value, GTK_VALUE_BOXED (*arg));      break;
 200     case G_TYPE_POINTER:        g_value_set_pointer (value, GTK_VALUE_POINTER (*arg));  break;
 201     case G_TYPE_OBJECT:         g_value_set_object (value, GTK_VALUE_POINTER (*arg));   break;
 202     default:
 203       return FALSE;
 204     }
 205   return TRUE;
 206 }
 207
 208 static inline gboolean
 209 gtk_arg_set_from_value (GtkArg  *arg,
 210                         GValue  *value,
 211                         gboolean copy_string)
 212 {
 213   switch (G_TYPE_FUNDAMENTAL (arg->type))
 214     {
 215     case G_TYPE_CHAR:           GTK_VALUE_CHAR (*arg) = g_value_get_char (value);       break;
 216     case G_TYPE_UCHAR:          GTK_VALUE_UCHAR (*arg) = g_value_get_uchar (value);     break;
 217     case G_TYPE_BOOLEAN:        GTK_VALUE_BOOL (*arg) = g_value_get_boolean (value);    break;
 218     case G_TYPE_INT:            GTK_VALUE_INT (*arg) = g_value_get_int (value);         break;
 219     case G_TYPE_UINT:           GTK_VALUE_UINT (*arg) = g_value_get_uint (value);       break;
 220     case G_TYPE_LONG:           GTK_VALUE_LONG (*arg) = g_value_get_long (value);       break;
 221     case G_TYPE_ULONG:          GTK_VALUE_ULONG (*arg) = g_value_get_ulong (value);     break;
 222     case G_TYPE_ENUM:           GTK_VALUE_ENUM (*arg) = g_value_get_enum (value);       break;
 223     case G_TYPE_FLAGS:          GTK_VALUE_FLAGS (*arg) = g_value_get_flags (value);     break;
 224     case G_TYPE_FLOAT:          GTK_VALUE_FLOAT (*arg) = g_value_get_float (value);     break;
 225     case G_TYPE_DOUBLE:         GTK_VALUE_DOUBLE (*arg) = g_value_get_double (value);   break;
 226     case G_TYPE_BOXED:          GTK_VALUE_BOXED (*arg) = g_value_get_boxed (value);     break;
 227     case G_TYPE_POINTER:        GTK_VALUE_POINTER (*arg) = g_value_get_pointer (value); break;
 228     case G_TYPE_OBJECT:         GTK_VALUE_POINTER (*arg) = g_value_get_object (value);  break;
 229     case G_TYPE_STRING:         if (copy_string)
 230       GTK_VALUE_STRING (*arg) = g_value_dup_string (value);
 231     else
 232       GTK_VALUE_STRING (*arg) = g_value_get_string (value);
 233     break;
 234     default:
 235       return FALSE;
 236     }
 237   return TRUE;
 238 }
 239
 240 static inline gboolean
 241 gtk_argloc_set_from_value (GtkArg  *arg,
 242                            GValue  *value,
 243                            gboolean copy_string)
 244 {
 245   switch (G_TYPE_FUNDAMENTAL (arg->type))
 246     {
 247     case G_TYPE_CHAR:           *GTK_RETLOC_CHAR (*arg) = g_value_get_char (value);       break;
 248     case G_TYPE_UCHAR:          *GTK_RETLOC_UCHAR (*arg) = g_value_get_uchar (value);     break;
 249     case G_TYPE_BOOLEAN:        *GTK_RETLOC_BOOL (*arg) = g_value_get_boolean (value);    break;
 250     case G_TYPE_INT:            *GTK_RETLOC_INT (*arg) = g_value_get_int (value);         break;
 251     case G_TYPE_UINT:           *GTK_RETLOC_UINT (*arg) = g_value_get_uint (value);       break;
 252     case G_TYPE_LONG:           *GTK_RETLOC_LONG (*arg) = g_value_get_long (value);       break;
 253     case G_TYPE_ULONG:          *GTK_RETLOC_ULONG (*arg) = g_value_get_ulong (value);     break;
 254     case G_TYPE_ENUM:           *GTK_RETLOC_ENUM (*arg) = g_value_get_enum (value);       break;
 255     case G_TYPE_FLAGS:          *GTK_RETLOC_FLAGS (*arg) = g_value_get_flags (value);     break;
 256     case G_TYPE_FLOAT:          *GTK_RETLOC_FLOAT (*arg) = g_value_get_float (value);     break;
 257     case G_TYPE_DOUBLE:         *GTK_RETLOC_DOUBLE (*arg) = g_value_get_double (value);   break;
 258     case G_TYPE_BOXED:          *GTK_RETLOC_BOXED (*arg) = g_value_get_boxed (value);     break;
 259     case G_TYPE_POINTER:        *GTK_RETLOC_POINTER (*arg) = g_value_get_pointer (value); break;
 260     case G_TYPE_OBJECT:         *GTK_RETLOC_POINTER (*arg) = g_value_get_object (value);  break;
 261     case G_TYPE_STRING:         if (copy_string)
 262       *GTK_RETLOC_STRING (*arg) = g_value_dup_string (value);
 263     else
 264       *GTK_RETLOC_STRING (*arg) = g_value_get_string (value);
 265     break;
 266     default:
 267       return FALSE;
 268     }
 269   return TRUE;
 270 }
 271
 272 void
 273 gtk_signal_emitv (GtkObject *object,
 274                   guint      signal_id,
 275                   GtkArg    *args)
 276 {
 277   GSignalQuery query;
 278   GValue params[SIGNAL_MAX_PARAMS + 1] = { { 0, }, };
 279   GValue rvalue = { 0, };
 280   guint i;
 281
 282   g_return_if_fail (GTK_IS_OBJECT (object));
 283
 284   g_signal_query (signal_id, &query);
 285   g_return_if_fail (query.signal_id != 0);
 286   g_return_if_fail (g_type_conforms_to (GTK_OBJECT_TYPE (object), query.itype));
 287   g_return_if_fail (query.n_params < SIGNAL_MAX_PARAMS);
 288   if (query.n_params > 0)
 289     g_return_if_fail (args != NULL);
 290
 291   g_value_init (params + 0, GTK_OBJECT_TYPE (object));
 292   g_value_set_object (params + 0, G_OBJECT (object));
 293   for (i = 0; i < query.n_params; i++)
 294     {
 295       GValue *value = params + 1 + i;
 296       GtkArg *arg = args + i;
 297
 298       g_value_init (value, arg->type);
 299       if (!gtk_arg_to_value (arg, value))
 300         {
 301           g_warning ("%s: failed to convert arg type `%s' to value type `%s'",
 302                      G_STRLOC, g_type_name (arg->type), g_type_name (G_VALUE_TYPE (value)));
 303           return;
 304         }
 305     }
 306   if (query.return_type != G_TYPE_NONE)
 307     g_value_init (&rvalue, query.return_type);
 308
 309   g_signal_emitv (params, signal_id, &rvalue);
 310
 311   if (query.return_type != G_TYPE_NONE)
 312     {
 313       gtk_argloc_set_from_value (args + query.n_params, &rvalue, TRUE);
 314       g_value_unset (&rvalue);
 315     }
 316   for (i = 0; i < query.n_params; i++)
 317     g_value_unset (params + 1 + i);
 318   g_value_unset (params + 0);
 319 }
 320
 321 static gboolean
 322 gtk_signal_collect_args (GtkArg        *args,
 323                          guint          n_args,
 324                          const GtkType *arg_types,
 325                          GtkType        return_type,
 326                          va_list        var_args)
 327 {
 328   register GtkArg *last_arg;
 329   register gboolean failed = FALSE;
 330
 331   for (last_arg = args + n_args; args < last_arg; args++)
 332     {
 333       register gchar *error;
 334
 335       args->name = NULL;
 336       args->type = *(arg_types++);
 337       GTK_ARG_COLLECT_VALUE (args,
 338                              var_args,
 339                              error);
 340       if (error)
 341         {
 342           failed = TRUE;
 343           g_warning ("gtk_signal_collect_args(): %s", error);
 344           g_free (error);
 345         }
 346     }
 347
 348   args->type = return_type;
 349   args->name = NULL;
 350
 351   return_type = GTK_FUNDAMENTAL_TYPE (return_type);
 352   if (return_type != G_TYPE_NONE)
 353     {
 354       if (return_type != 0) /* FIXME: check for IS_ARG */
 355         {
 356           GTK_VALUE_POINTER (*args) = va_arg (var_args, gpointer);
 357
 358           if (GTK_VALUE_POINTER (*args) == NULL)
 359             {
 360               failed = TRUE;
 361               g_warning ("gtk_signal_collect_args(): invalid NULL pointer for return argument type `%s'",
 362                          gtk_type_name (args->type));
 363             }
 364         }
 365       else
 366         {
 367           failed = TRUE;
 368           g_warning ("gtk_signal_collect_args(): unsupported return argument type `%s'",
 369                      gtk_type_name (args->type));
 370         }
 371     }
 372   else
 373     GTK_VALUE_POINTER (*args) = NULL;
 374
 375   return failed;
 376 }
 377
 378 void
 379 gtk_signal_emit (GtkObject *object,
 380                  guint      signal_id,
 381                  ...)
 382 {
 383   GtkArg args[SIGNAL_MAX_PARAMS + 1];
 384   GSignalQuery query;
 385   gboolean abort;
 386   va_list var_args;
 387
 388   g_return_if_fail (GTK_IS_OBJECT (object));
 389
 390   g_signal_query (signal_id, &query);
 391   g_return_if_fail (query.signal_id != 0);
 392   g_return_if_fail (query.n_params < SIGNAL_MAX_PARAMS);
 393
 394   va_start (var_args, signal_id);
 395   abort = gtk_signal_collect_args (args,
 396                                    query.n_params,
 397                                    query.param_types,
 398                                    query.return_type,
 399                                    var_args);
 400   va_end (var_args);
 401
 402   if (!abort)
 403     gtk_signal_emitv (object, signal_id, args);
 404 }
 405
 406 void
 407 gtk_signal_emit_by_name (GtkObject   *object,
 408                          const gchar *name,
 409                          ...)
 410 {
 411   GtkArg args[SIGNAL_MAX_PARAMS + 1];
 412   GSignalQuery query;
 413   gboolean abort;
 414   va_list var_args;
 415
 416   g_return_if_fail (GTK_IS_OBJECT (object));
 417   g_return_if_fail (name != NULL);
 418
 419   g_signal_query (g_signal_lookup (name, GTK_OBJECT_TYPE (object)), &query);
 420   g_return_if_fail (query.signal_id != 0);
 421   g_return_if_fail (query.n_params < SIGNAL_MAX_PARAMS);
 422
 423   va_start (var_args, name);
 424   abort = gtk_signal_collect_args (args,
 425                                    query.n_params,
 426                                    query.param_types,
 427                                    query.return_type,
 428                                    var_args);
 429   va_end (var_args);
 430
 431   if (!abort)
 432     gtk_signal_emitv (object, query.signal_id, args);
 433 }
 434
 435 void
 436 gtk_signal_emitv_by_name (GtkObject   *object,
 437                           const gchar *name,
 438                           GtkArg      *args)
 439 {
 440   g_return_if_fail (GTK_IS_OBJECT (object));
 441
 442   gtk_signal_emitv (object, g_signal_lookup (name, GTK_OBJECT_TYPE (object)), args);
 443 }