gobject/gtype-private.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1998-1999, 2000-2001 Tim Janik and 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.1 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, see <http://www.gnu.org/licenses/>.
  16  */
  17 #ifndef __G_TYPE_PRIVATE_H__
  18 #define __G_TYPE_PRIVATE_H__
  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 #include "gboxed.h"
  25 #include "gclosure.h"
  26
  27 /*< private >
  28  * GOBJECT_IF_DEBUG:
  29  * @debug_type: Currently only OBJECTS and SIGNALS are supported.
  30  * @code_block: Custom debug code.
  31  *
  32  * A convenience macro for debugging GObject.
  33  * This macro is only used internally.
  34  */
  35 #ifdef G_ENABLE_DEBUG
  36 #define GOBJECT_IF_DEBUG(debug_type, code_block) \
  37 G_STMT_START { \
  38     if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) \
  39       { code_block; } \
  40 } G_STMT_END
  41 #else   /* !G_ENABLE_DEBUG */
  42 #define GOBJECT_IF_DEBUG(debug_type, code_block)
  43 #endif  /* G_ENABLE_DEBUG */
  44
  45 G_BEGIN_DECLS
  46
  47 extern GTypeDebugFlags _g_type_debug_flags;
  48
  49 typedef struct _GRealClosure  GRealClosure;
  50 struct _GRealClosure
  51 {
  52   GClosureMarshal meta_marshal;
  53   gpointer meta_marshal_data;
  54   GVaClosureMarshal va_meta_marshal;
  55   GVaClosureMarshal va_marshal;
  56   GClosure closure;
  57 };
  58
  59 #define G_REAL_CLOSURE(_c) \
  60   ((GRealClosure *)G_STRUCT_MEMBER_P ((_c), -G_STRUCT_OFFSET (GRealClosure, closure)))
  61
  62 void    _g_value_c_init          (void); /* sync with gvalue.c */
  63 void    _g_value_types_init      (void); /* sync with gvaluetypes.c */
  64 void    _g_enum_types_init       (void); /* sync with genums.c */
  65 void    _g_param_type_init       (void); /* sync with gparam.c */
  66 void    _g_boxed_type_init       (void); /* sync with gboxed.c */
  67 void    _g_object_type_init      (void); /* sync with gobject.c */
  68 void    _g_param_spec_types_init (void); /* sync with gparamspecs.c */
  69 void    _g_value_transforms_init (void); /* sync with gvaluetransform.c */
  70 void    _g_signal_init           (void); /* sync with gsignal.c */
  71
  72 /* for gboxed.c */
  73 gpointer        _g_type_boxed_copy      (GType          type,
  74                                          gpointer       value);
  75 void            _g_type_boxed_free      (GType          type,
  76                                          gpointer       value);
  77 void            _g_type_boxed_init      (GType          type,
  78                                          GBoxedCopyFunc copy_func,
  79                                          GBoxedFreeFunc free_func);
  80
  81 gboolean    _g_closure_is_void (GClosure       *closure,
  82                                 gpointer        instance);
  83 gboolean    _g_closure_supports_invoke_va (GClosure       *closure);
  84 void        _g_closure_set_va_marshal (GClosure       *closure,
  85                                        GVaClosureMarshal marshal);
  86 void        _g_closure_invoke_va (GClosure       *closure,
  87                                   GValue /*out*/ *return_value,
  88                                   gpointer        instance,
  89                                   va_list         args,
  90                                   int             n_params,
  91                                   GType          *param_types);
  92
  93 /**
  94  * _G_DEFINE_TYPE_EXTENDED_WITH_PRELUDE:
  95  *
  96  * See also G_DEFINE_TYPE_EXTENDED().  This macro is generally only
  97  * necessary as a workaround for classes which have properties of
  98  * object types that may be initialized in distinct threads.  See:
  99  * https://bugzilla.gnome.org/show_bug.cgi?id=674885
 100  *
 101  * Currently private.
 102  */
 103 #define _G_DEFINE_TYPE_EXTENDED_WITH_PRELUDE(TN, t_n, T_P, _f_, _P_, _C_)           _G_DEFINE_TYPE_EXTENDED_BEGIN_PRE (TN, t_n, T_P) {_P_;} _G_DEFINE_TYPE_EXTENDED_BEGIN_REGISTER (TN, t_n, T_P, _f_){_C_;} _G_DEFINE_TYPE_EXTENDED_END()
 104
 105 G_END_DECLS
 106
 107 #endif /* __G_TYPE_PRIVATE_H__ */