gobject/gboxed.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_BOXED_H__
  20 #define __G_BOXED_H__
  21
  22 #include        <gobject/gtype.h>
  23
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29
  30 /* --- type macros --- */
  31 #define G_TYPE_IS_BOXED(type)      (G_TYPE_FUNDAMENTAL (type) == G_TYPE_BOXED)
  32 #define G_VALUE_HOLDS_BOXED(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOXED))
  33
  34
  35 /* --- typedefs --- */
  36 typedef struct _GBoxed  GBoxed;
  37 typedef gpointer (*GBoxedInitFunc)      (void);
  38 typedef gpointer (*GBoxedCopyFunc)      (gpointer        boxed);
  39 typedef void     (*GBoxedFreeFunc)      (gpointer        boxed);
  40
  41
  42 /* --- prototypes --- */
  43 GBoxed*         g_boxed_copy                    (GType           boxed_type,
  44                                                  gconstpointer   src_boxed);
  45 void            g_boxed_free                    (GType           boxed_type,
  46                                                  gpointer        boxed);
  47 void            g_value_set_boxed               (GValue         *value,
  48                                                  gconstpointer   boxed);
  49 void            g_value_set_static_boxed        (GValue         *value,
  50                                                  gconstpointer   boxed);
  51 gpointer        g_value_get_boxed               (const GValue   *value);
  52 gpointer        g_value_dup_boxed               (GValue         *value);
  53
  54
  55 /* --- convenience --- */
  56 GType   g_boxed_type_register_static            (const gchar    *name,
  57                                                  GBoxedInitFunc  boxed_init,
  58                                                  GBoxedCopyFunc  boxed_copy,
  59                                                  GBoxedFreeFunc  boxed_free,
  60                                                  gboolean        is_refcounted);
  61
  62
  63 /* --- marshaller specific --- */
  64 void    g_value_set_boxed_take_ownership        (GValue         *value,
  65                                                  gconstpointer   boxed);
  66
  67
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif /* __cplusplus */
  72
  73 #endif  /* __G_BOXED_H__ */