gobject/gsignal.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 2000-2001 Red Hat, Inc.
   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
  15  * Public 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 #ifndef __G_SIGNAL_H__
  20 #define __G_SIGNAL_H__
  21
  22
  23 #include        <gobject/gclosure.h>
  24 #include        <gobject/gvalue.h>
  25 #include        <gobject/gparam.h>
  26 #include        <gobject/gmarshal.h>
  27 #include        <signal.h>
  28
  29 G_BEGIN_DECLS
  30
  31 /* --- typedefs --- */
  32 typedef struct _GSignalQuery             GSignalQuery;
  33 typedef struct _GSignalInvocationHint    GSignalInvocationHint;
  34 typedef GClosureMarshal                  GSignalCMarshaller;
  35 typedef gboolean (*GSignalEmissionHook) (GSignalInvocationHint *ihint,
  36                                          guint                  n_param_values,
  37                                          const GValue          *param_values,
  38                                          gpointer               data);
  39 typedef gboolean (*GSignalAccumulator)  (GSignalInvocationHint *ihint,
  40                                          GValue                *return_accu,
  41                                          const GValue          *handler_return,
  42                                          gpointer               data);
  43
  44
  45 /* --- run, match and connect types --- */
  46 typedef enum
  47 {
  48   G_SIGNAL_RUN_FIRST    = 1 << 0,
  49   G_SIGNAL_RUN_LAST     = 1 << 1,
  50   G_SIGNAL_RUN_CLEANUP  = 1 << 2,
  51   G_SIGNAL_NO_RECURSE   = 1 << 3,
  52   G_SIGNAL_DETAILED     = 1 << 4,
  53   G_SIGNAL_ACTION       = 1 << 5,
  54   G_SIGNAL_NO_HOOKS     = 1 << 6
  55 } GSignalFlags;
  56 #define G_SIGNAL_FLAGS_MASK  0x7f
  57 typedef enum
  58 {
  59   G_CONNECT_AFTER       = 1 << 0,
  60   G_CONNECT_SWAPPED     = 1 << 1
  61 } GConnectFlags;
  62 typedef enum
  63 {
  64   G_SIGNAL_MATCH_ID        = 1 << 0,
  65   G_SIGNAL_MATCH_DETAIL    = 1 << 1,
  66   G_SIGNAL_MATCH_CLOSURE   = 1 << 2,
  67   G_SIGNAL_MATCH_FUNC      = 1 << 3,
  68   G_SIGNAL_MATCH_DATA      = 1 << 4,
  69   G_SIGNAL_MATCH_UNBLOCKED = 1 << 5
  70 } GSignalMatchType;
  71 #define G_SIGNAL_MATCH_MASK  0x3f
  72 #define G_SIGNAL_TYPE_STATIC_SCOPE (G_TYPE_FLAG_RESERVED_ID_BIT)
  73
  74
  75 /* --- signal information --- */
  76 struct _GSignalInvocationHint
  77 {
  78   guint         signal_id;
  79   GQuark        detail;
  80   GSignalFlags  run_type;
  81 };
  82 struct _GSignalQuery
  83 {
  84   guint         signal_id;
  85   const gchar  *signal_name;
  86   GType         itype;
  87   GSignalFlags  signal_flags;
  88   GType         return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
  89   guint         n_params;
  90   const GType  *param_types; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
  91 };
  92
  93
  94 /* --- signals --- */
  95 guint                 g_signal_newv         (const gchar        *signal_name,
  96                                              GType               itype,
  97                                              GSignalFlags        signal_flags,
  98                                              GClosure           *class_closure,
  99                                              GSignalAccumulator  accumulator,
 100                                              gpointer            accu_data,
 101                                              GSignalCMarshaller  c_marshaller,
 102                                              GType               return_type,
 103                                              guint               n_params,
 104                                              GType              *param_types);
 105 guint                 g_signal_new_valist   (const gchar        *signal_name,
 106                                              GType               itype,
 107                                              GSignalFlags        signal_flags,
 108                                              GClosure           *class_closure,
 109                                              GSignalAccumulator  accumulator,
 110                                              gpointer            accu_data,
 111                                              GSignalCMarshaller  c_marshaller,
 112                                              GType               return_type,
 113                                              guint               n_params,
 114                                              va_list             args);
 115 guint                 g_signal_new          (const gchar        *signal_name,
 116                                              GType               itype,
 117                                              GSignalFlags        signal_flags,
 118                                              guint               class_offset,
 119                                              GSignalAccumulator  accumulator,
 120                                              gpointer            accu_data,
 121                                              GSignalCMarshaller  c_marshaller,
 122                                              GType               return_type,
 123                                              guint               n_params,
 124                                              ...);
 125 void                  g_signal_emitv        (const GValue       *instance_and_params,
 126                                              guint               signal_id,
 127                                              GQuark              detail,
 128                                              GValue             *return_value);
 129 void                  g_signal_emit_valist  (gpointer            instance,
 130                                              guint               signal_id,
 131                                              GQuark              detail,
 132                                              va_list             var_args);
 133 void                  g_signal_emit         (gpointer            instance,
 134                                              guint               signal_id,
 135                                              GQuark              detail,
 136                                              ...);
 137 void                  g_signal_emit_by_name (gpointer            instance,
 138                                              const gchar        *detailed_signal,
 139                                              ...);
 140 guint                 g_signal_lookup       (const gchar        *name,
 141                                              GType               itype);
 142 G_CONST_RETURN gchar* g_signal_name         (guint               signal_id);
 143 void                  g_signal_query        (guint               signal_id,
 144                                              GSignalQuery       *query);
 145 guint*                g_signal_list_ids     (GType               itype,
 146                                              guint              *n_ids);
 147 gboolean              g_signal_parse_name   (const gchar        *detailed_signal,
 148                                              GType               itype,
 149                                              guint              *signal_id_p,
 150                                              GQuark             *detail_p,
 151                                              gboolean            force_detail_quark);
 152
 153
 154 /* --- signal emissions --- */
 155 void    g_signal_stop_emission              (gpointer             instance,
 156                                              guint                signal_id,
 157                                              GQuark               detail);
 158 void    g_signal_stop_emission_by_name      (gpointer             instance,
 159                                              const gchar         *detailed_signal);
 160 gulong  g_signal_add_emission_hook          (guint                signal_id,
 161                                              GQuark               quark,
 162                                              GSignalEmissionHook  hook_func,
 163                                              gpointer             hook_data,
 164                                              GDestroyNotify       data_destroy);
 165 void    g_signal_remove_emission_hook       (guint                signal_id,
 166                                              gulong               hook_id);
 167
 168
 169 /* --- signal handlers --- */
 170 gboolean g_signal_has_handler_pending         (gpointer           instance,
 171                                                guint              signal_id,
 172                                                GQuark             detail,
 173                                                gboolean           may_be_blocked);
 174 gulong   g_signal_connect_closure_by_id       (gpointer           instance,
 175                                                guint              signal_id,
 176                                                GQuark             detail,
 177                                                GClosure          *closure,
 178                                                gboolean           after);
 179 gulong   g_signal_connect_closure             (gpointer           instance,
 180                                                const gchar       *detailed_signal,
 181                                                GClosure          *closure,
 182                                                gboolean           after);
 183 gulong   g_signal_connect_data                (gpointer           instance,
 184                                                const gchar       *detailed_signal,
 185                                                GCallback          c_handler,
 186                                                gpointer           data,
 187                                                GClosureNotify     destroy_data,
 188                                                GConnectFlags      connect_flags);
 189 void     g_signal_handler_block               (gpointer           instance,
 190                                                gulong             handler_id);
 191 void     g_signal_handler_unblock             (gpointer           instance,
 192                                                gulong             handler_id);
 193 void     g_signal_handler_disconnect          (gpointer           instance,
 194                                                gulong             handler_id);
 195 gboolean g_signal_handler_is_connected        (gpointer           instance,
 196                                                gulong             handler_id);
 197 gulong   g_signal_handler_find                (gpointer           instance,
 198                                                GSignalMatchType   mask,
 199                                                guint              signal_id,
 200                                                GQuark             detail,
 201                                                GClosure          *closure,
 202                                                gpointer           func,
 203                                                gpointer           data);
 204 guint    g_signal_handlers_block_matched      (gpointer           instance,
 205                                                GSignalMatchType   mask,
 206                                                guint              signal_id,
 207                                                GQuark             detail,
 208                                                GClosure          *closure,
 209                                                gpointer           func,
 210                                                gpointer           data);
 211 guint    g_signal_handlers_unblock_matched    (gpointer           instance,
 212                                                GSignalMatchType   mask,
 213                                                guint              signal_id,
 214                                                GQuark             detail,
 215                                                GClosure          *closure,
 216                                                gpointer           func,
 217                                                gpointer           data);
 218 guint    g_signal_handlers_disconnect_matched (gpointer           instance,
 219                                                GSignalMatchType   mask,
 220                                                guint              signal_id,
 221                                                GQuark             detail,
 222                                                GClosure          *closure,
 223                                                gpointer           func,
 224                                                gpointer           data);
 225
 226
 227 /* --- chaining for language bindings --- */
 228 void    g_signal_override_class_closure       (guint              signal_id,
 229                                                GType              instance_type,
 230                                                GClosure          *class_closure);
 231 void    g_signal_chain_from_overridden        (const GValue      *instance_and_params,
 232                                                guint              signal_id,
 233                                                GValue            *return_value);
 234
 235
 236 /* --- convenience --- */
 237 #define g_signal_connect(instance, detailed_signal, c_handler, data) \
 238     g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, 0)
 239 #define g_signal_connect_after(instance, detailed_signal, c_handler, data) \
 240     g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_AFTER)
 241 #define g_signal_connect_swapped(instance, detailed_signal, c_handler, data) \
 242     g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_SWAPPED)
 243 #define g_signal_handlers_disconnect_by_func(instance, func, data) \
 244     g_signal_handlers_disconnect_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
 245                                           0, 0, NULL, (func), (data))
 246 #define g_signal_handlers_block_by_func(instance, func, data) \
 247     g_signal_handlers_block_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
 248                                      0, 0, NULL, (func), (data))
 249 #define g_signal_handlers_unblock_by_func(instance, func, data) \
 250     g_signal_handlers_unblock_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
 251                                        0, 0, NULL, (func), (data))
 252
 253
 254 /*< private >*/
 255 void     g_signal_handlers_destroy            (gpointer           instance);
 256 void     _g_signals_destroy                   (GType              itype);
 257
 258 G_END_DECLS
 259
 260 #endif /* __G_SIGNAL_H__ */