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 G_BEGIN_DECLS
  25
  26 /* --- type macros --- */
  27 #define G_TYPE_IS_BOXED(type)      (G_TYPE_FUNDAMENTAL (type) == G_TYPE_BOXED)
  28 #define G_VALUE_HOLDS_BOXED(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOXED))
  29
  30
  31 /* --- typedefs --- */
  32 typedef struct _GBoxed  GBoxed;
  33 typedef gpointer (*GBoxedInitFunc)      (void);
  34 typedef gpointer (*GBoxedCopyFunc)      (gpointer        boxed);
  35 typedef void     (*GBoxedFreeFunc)      (gpointer        boxed);
  36
  37
  38 /* --- prototypes --- */
  39 GBoxed*         g_boxed_copy                    (GType           boxed_type,
  40                                                  gconstpointer   src_boxed);
  41 void            g_boxed_free                    (GType           boxed_type,
  42                                                  gpointer        boxed);
  43 void            g_value_set_boxed               (GValue         *value,
  44                                                  gconstpointer   boxed);
  45 void            g_value_set_static_boxed        (GValue         *value,
  46                                                  gconstpointer   boxed);
  47 gpointer        g_value_get_boxed               (const GValue   *value);
  48 gpointer        g_value_dup_boxed               (const GValue   *value);
  49
  50
  51 /* --- convenience --- */
  52 GType   g_boxed_type_register_static            (const gchar    *name,
  53                                                  GBoxedInitFunc  boxed_init,
  54                                                  GBoxedCopyFunc  boxed_copy,
  55                                                  GBoxedFreeFunc  boxed_free,
  56                                                  gboolean        is_refcounted);
  57
  58
  59 /* --- marshaller specific --- */
  60 void    g_value_set_boxed_take_ownership        (GValue         *value,
  61                                                  gconstpointer   boxed);
  62
  63
  64
  65 G_END_DECLS
  66
  67 #endif  /* __G_BOXED_H__ */