gobject/gvaluetypes.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  * gvaluetypes.h: GLib default values
  20  */
  21 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  22 #error "Only <glib-object.h> can be included directly."
  23 #endif
  24
  25 #ifndef __G_VALUETYPES_H__
  26 #define __G_VALUETYPES_H__
  27
  28 #include        <gobject/gvalue.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /* --- type macros --- */
  33 #define G_VALUE_HOLDS_CHAR(value)        (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_CHAR))
  34 #define G_VALUE_HOLDS_UCHAR(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UCHAR))
  35 #define G_VALUE_HOLDS_BOOLEAN(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOOLEAN))
  36 #define G_VALUE_HOLDS_INT(value)         (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_INT))
  37 #define G_VALUE_HOLDS_UINT(value)        (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UINT))
  38 #define G_VALUE_HOLDS_LONG(value)        (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_LONG))
  39 #define G_VALUE_HOLDS_ULONG(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_ULONG))
  40 #define G_VALUE_HOLDS_INT64(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_INT64))
  41 #define G_VALUE_HOLDS_UINT64(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UINT64))
  42 #define G_VALUE_HOLDS_FLOAT(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_FLOAT))
  43 #define G_VALUE_HOLDS_DOUBLE(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_DOUBLE))
  44 #define G_VALUE_HOLDS_STRING(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_STRING))
  45 #define G_VALUE_HOLDS_POINTER(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_POINTER))
  46 /**
  47  * G_TYPE_GTYPE:
  48  *
  49  * The type for #GType.
  50  */
  51 #define G_TYPE_GTYPE                     (g_gtype_get_type())
  52 #define G_VALUE_HOLDS_GTYPE(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_GTYPE))
  53
  54
  55 /* --- prototypes --- */
  56 void                  g_value_set_char          (GValue       *value,
  57                                                  gchar         v_char);
  58 gchar                 g_value_get_char          (const GValue *value);
  59 void                  g_value_set_uchar         (GValue       *value,
  60                                                  guchar        v_uchar);
  61 guchar                g_value_get_uchar         (const GValue *value);
  62 void                  g_value_set_boolean       (GValue       *value,
  63                                                  gboolean      v_boolean);
  64 gboolean              g_value_get_boolean       (const GValue *value);
  65 void                  g_value_set_int           (GValue       *value,
  66                                                  gint          v_int);
  67 gint                  g_value_get_int           (const GValue *value);
  68 void                  g_value_set_uint          (GValue       *value,
  69                                                  guint         v_uint);
  70 guint                 g_value_get_uint          (const GValue *value);
  71 void                  g_value_set_long          (GValue       *value,
  72                                                  glong         v_long);
  73 glong                 g_value_get_long          (const GValue *value);
  74 void                  g_value_set_ulong         (GValue       *value,
  75                                                  gulong        v_ulong);
  76 gulong                g_value_get_ulong         (const GValue *value);
  77 void                  g_value_set_int64         (GValue       *value,
  78                                                  gint64        v_int64);
  79 gint64                g_value_get_int64         (const GValue *value);
  80 void                  g_value_set_uint64        (GValue       *value,
  81                                                  guint64      v_uint64);
  82 guint64               g_value_get_uint64        (const GValue *value);
  83 void                  g_value_set_float         (GValue       *value,
  84                                                  gfloat        v_float);
  85 gfloat                g_value_get_float         (const GValue *value);
  86 void                  g_value_set_double        (GValue       *value,
  87                                                  gdouble       v_double);
  88 gdouble               g_value_get_double        (const GValue *value);
  89 void                  g_value_set_string        (GValue       *value,
  90                                                  const gchar  *v_string);
  91 void                  g_value_set_static_string (GValue       *value,
  92                                                  const gchar  *v_string);
  93 G_CONST_RETURN gchar* g_value_get_string        (const GValue *value);
  94 gchar*                g_value_dup_string        (const GValue *value);
  95 void                  g_value_set_pointer       (GValue       *value,
  96                                                  gpointer      v_pointer);
  97 gpointer              g_value_get_pointer       (const GValue *value);
  98 GType                 g_gtype_get_type          (void);
  99 void                  g_value_set_gtype         (GValue       *value,
 100                                                  GType         v_gtype);
 101 GType                 g_value_get_gtype         (const GValue *value);
 102
 103
 104 /* Convenience for registering new pointer types */
 105 GType                 g_pointer_type_register_static (const gchar *name);
 106
 107 /* debugging aid, describe value contents as string */
 108 gchar*                g_strdup_value_contents   (const GValue *value);
 109
 110
 111 void g_value_take_string                        (GValue            *value,
 112                                                  gchar             *v_string);
 113 #ifndef G_DISABLE_DEPRECATED
 114 void g_value_set_string_take_ownership          (GValue            *value,
 115                                                  gchar             *v_string);
 116 #endif
 117
 118
 119 /* humpf, need a C representable type name for G_TYPE_STRING */
 120 typedef gchar* gchararray;
 121
 122
 123 G_END_DECLS
 124
 125 #endif /* __G_VALUETYPES_H__ */