gobject/gvalue.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1997-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 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  * gvalue.h: generic GValue functions
  20  */
  21 #ifndef __G_VALUE_H__
  22 #define __G_VALUE_H__
  23
  24
  25 #include        <gobject/gtype.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif /* __cplusplus */
  30
  31
  32 /* --- type macros --- */
  33 #define G_TYPE_IS_VALUE(type)           (g_type_value_table_peek (type) != NULL)
  34 #define G_IS_VALUE(value)               (G_TYPE_CHECK_VALUE (value))
  35 #define G_VALUE_TYPE(value)             (((GValue*) (value))->g_type)
  36 #define G_VALUE_TYPE_NAME(value)        (g_type_name (G_VALUE_TYPE (value)))
  37 #define G_VALUE_HOLDS(value,type)       (G_TYPE_CHECK_VALUE_TYPE ((value), (type)))
  38
  39
  40 /* --- typedefs & structures --- */
  41 typedef void (*GValueExchange)  (GValue       *value1,
  42                                  GValue       *value2);
  43 typedef void (*GValueTransform) (const GValue *src_value,
  44                                  GValue       *dest_value);
  45 struct _GValue
  46 {
  47   /*< private >*/
  48   GType         g_type;
  49
  50   /* public for GTypeValueTable methods */
  51   union {
  52     gint        v_int;
  53     guint       v_uint;
  54     glong       v_long;
  55     gulong      v_ulong;
  56     gfloat      v_float;
  57     gdouble     v_double;
  58     gpointer    v_pointer;
  59   } data[4];
  60 };
  61
  62
  63 /* --- prototypes --- */
  64 GValue*         g_value_init            (GValue       *value,
  65                                          GType         g_type);
  66 void            g_value_copy            (const GValue *src_value,
  67                                          GValue       *dest_value);
  68 gboolean        g_value_convert         (const GValue *src_value,
  69                                          GValue       *dest_value);
  70 GValue*         g_value_reset           (GValue       *value);
  71 void            g_value_unset           (GValue       *value);
  72 void            g_value_set_instance    (GValue       *value,
  73                                          gpointer      instance);
  74
  75
  76 /* --- private --- */
  77 gboolean        g_value_fits_pointer    (const GValue *value);
  78 gpointer        g_value_peek_pointer    (const GValue *value);
  79
  80
  81 /* --- implementation details --- */
  82 gboolean g_value_type_compatible        (GType           src_type,
  83                                          GType           dest_type);
  84 gboolean g_value_type_transformable     (GType           src_type,
  85                                          GType           dest_type);
  86 gboolean g_value_transform              (const GValue   *src_value,
  87                                          GValue         *dest_value);
  88 void    g_value_register_transform_func (GType           src_type,
  89                                          GType           dest_type,
  90                                          GValueTransform transform_func);
  91 #define G_VALUE_NOCOPY_CONTENTS         (1 << 27)
  92
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif /* __cplusplus */
  97
  98 #endif /* __G_VALUE_H__ */