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 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  20 #error "Only <glib-object.h> can be included directly."
  21 #endif
  22
  23 #ifndef __G_BOXED_H__
  24 #define __G_BOXED_H__
  25
  26 #include        <gobject/gtype.h>
  27
  28 G_BEGIN_DECLS
  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 gpointer (*GBoxedCopyFunc)      (gpointer        boxed);
  37 typedef void     (*GBoxedFreeFunc)      (gpointer        boxed);
  38
  39
  40 /* --- prototypes --- */
  41 gpointer        g_boxed_copy                    (GType           boxed_type,
  42                                                  gconstpointer   src_boxed);
  43 void            g_boxed_free                    (GType           boxed_type,
  44                                                  gpointer        boxed);
  45 void            g_value_set_boxed               (GValue         *value,
  46                                                  gconstpointer   v_boxed);
  47 void            g_value_set_static_boxed        (GValue         *value,
  48                                                  gconstpointer   v_boxed);
  49 gpointer        g_value_get_boxed               (const GValue   *value);
  50 gpointer        g_value_dup_boxed               (const GValue   *value);
  51
  52
  53 /* --- convenience --- */
  54 GType   g_boxed_type_register_static            (const gchar    *name,
  55                                                  GBoxedCopyFunc  boxed_copy,
  56                                                  GBoxedFreeFunc  boxed_free);
  57
  58
  59 /* --- GLib boxed types --- */
  60 #define G_TYPE_CLOSURE          (g_closure_get_type ())
  61 #define G_TYPE_VALUE            (g_value_get_type ())
  62 #define G_TYPE_VALUE_ARRAY      (g_value_array_get_type ())
  63 #define G_TYPE_STRV             (g_strv_get_type ())
  64 #define G_TYPE_GSTRING          (g_gstring_get_type ())
  65
  66
  67 void    g_value_take_boxed      (GValue         *value,
  68                                  gconstpointer   v_boxed);
  69 #ifndef G_DISABLE_DEPRECATED
  70 void    g_value_set_boxed_take_ownership        (GValue         *value,
  71                                                  gconstpointer   v_boxed);
  72 #endif
  73 GType   g_closure_get_type      (void)  G_GNUC_CONST;
  74 GType   g_value_get_type        (void)  G_GNUC_CONST;
  75 GType   g_value_array_get_type  (void)  G_GNUC_CONST;
  76 GType   g_strv_get_type         (void)  G_GNUC_CONST;
  77 GType   g_gstring_get_type      (void)  G_GNUC_CONST;
  78
  79 typedef gchar** GStrv;
  80
  81 G_END_DECLS
  82
  83 #endif  /* __G_BOXED_H__ */