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 #ifndef __G_VALUETYPES_H__
  22 #define __G_VALUETYPES_H__
  23
  24 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  25 #error "Only <glib-object.h> can be included directly."
  26 #endif
  27
  28 #include        <gobject/gvalue.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /* --- type macros --- */
  33 /**
  34  * G_VALUE_HOLDS_CHAR:
  35  * @value: a valid #GValue structure
  36  *
  37  * Checks whether the given #GValue can hold values of type %G_TYPE_CHAR.
  38  *
  39  * Returns: %TRUE on success.
  40  */
  41 #define G_VALUE_HOLDS_CHAR(value)        (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_CHAR))
  42 /**
  43  * G_VALUE_HOLDS_UCHAR:
  44  * @value: a valid #GValue structure
  45  *
  46  * Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR.
  47  *
  48  * Returns: %TRUE on success.
  49  */
  50 #define G_VALUE_HOLDS_UCHAR(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UCHAR))
  51 /**
  52  * G_VALUE_HOLDS_BOOLEAN:
  53  * @value: a valid #GValue structure
  54  *
  55  * Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN.
  56  *
  57  * Returns: %TRUE on success.
  58  */
  59 #define G_VALUE_HOLDS_BOOLEAN(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOOLEAN))
  60 /**
  61  * G_VALUE_HOLDS_INT:
  62  * @value: a valid #GValue structure
  63  *
  64  * Checks whether the given #GValue can hold values of type %G_TYPE_INT.
  65  *
  66  * Returns: %TRUE on success.
  67  */
  68 #define G_VALUE_HOLDS_INT(value)         (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_INT))
  69 /**
  70  * G_VALUE_HOLDS_UINT:
  71  * @value: a valid #GValue structure
  72  *
  73  * Checks whether the given #GValue can hold values of type %G_TYPE_UINT.
  74  *
  75  * Returns: %TRUE on success.
  76  */
  77 #define G_VALUE_HOLDS_UINT(value)        (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UINT))
  78 /**
  79  * G_VALUE_HOLDS_LONG:
  80  * @value: a valid #GValue structure
  81  *
  82  * Checks whether the given #GValue can hold values of type %G_TYPE_LONG.
  83  *
  84  * Returns: %TRUE on success.
  85  */
  86 #define G_VALUE_HOLDS_LONG(value)        (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_LONG))
  87 /**
  88  * G_VALUE_HOLDS_ULONG:
  89  * @value: a valid #GValue structure
  90  *
  91  * Checks whether the given #GValue can hold values of type %G_TYPE_ULONG.
  92  *
  93  * Returns: %TRUE on success.
  94  */
  95 #define G_VALUE_HOLDS_ULONG(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_ULONG))
  96 /**
  97  * G_VALUE_HOLDS_INT64:
  98  * @value: a valid #GValue structure
  99  *
 100  * Checks whether the given #GValue can hold values of type %G_TYPE_INT64.
 101  *
 102  * Returns: %TRUE on success.
 103  */
 104 #define G_VALUE_HOLDS_INT64(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_INT64))
 105 /**
 106  * G_VALUE_HOLDS_UINT64:
 107  * @value: a valid #GValue structure
 108  *
 109  * Checks whether the given #GValue can hold values of type %G_TYPE_UINT64.
 110  *
 111  * Returns: %TRUE on success.
 112  */
 113 #define G_VALUE_HOLDS_UINT64(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_UINT64))
 114 /**
 115  * G_VALUE_HOLDS_FLOAT:
 116  * @value: a valid #GValue structure
 117  *
 118  * Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT.
 119  *
 120  * Returns: %TRUE on success.
 121  */
 122 #define G_VALUE_HOLDS_FLOAT(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_FLOAT))
 123 /**
 124  * G_VALUE_HOLDS_DOUBLE:
 125  * @value: a valid #GValue structure
 126  *
 127  * Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE.
 128  *
 129  * Returns: %TRUE on success.
 130  */
 131 #define G_VALUE_HOLDS_DOUBLE(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_DOUBLE))
 132 /**
 133  * G_VALUE_HOLDS_STRING:
 134  * @value: a valid #GValue structure
 135  *
 136  * Checks whether the given #GValue can hold values of type %G_TYPE_STRING.
 137  *
 138  * Returns: %TRUE on success.
 139  */
 140 #define G_VALUE_HOLDS_STRING(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_STRING))
 141 /**
 142  * G_VALUE_HOLDS_POINTER:
 143  * @value: a valid #GValue structure
 144  *
 145  * Checks whether the given #GValue can hold values of type %G_TYPE_POINTER.
 146  *
 147  * Returns: %TRUE on success.
 148  */
 149 #define G_VALUE_HOLDS_POINTER(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_POINTER))
 150 /**
 151  * G_TYPE_GTYPE:
 152  *
 153  * The type for #GType.
 154  */
 155 #define G_TYPE_GTYPE                     (g_gtype_get_type())
 156 /**
 157  * G_VALUE_HOLDS_GTYPE:
 158  * @value: a valid #GValue structure
 159  *
 160  * Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE.
 161  *
 162  * Since: 2.12
 163  * Returns: %TRUE on success.
 164  */
 165 #define G_VALUE_HOLDS_GTYPE(value)       (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_GTYPE))
 166 /**
 167  * G_VALUE_HOLDS_VARIANT:
 168  * @value: a valid #GValue structure
 169  *
 170  * Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT.
 171  *
 172  * Returns: %TRUE on success.
 173  *
 174  * Since: 2.26
 175  */
 176 #define G_VALUE_HOLDS_VARIANT(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_VARIANT))
 177
 178
 179 /* --- prototypes --- */
 180 GLIB_DEPRECATED_IN_2_32_FOR(g_value_set_schar)
 181 void                  g_value_set_char          (GValue       *value,
 182                                                  gchar         v_char);
 183 GLIB_DEPRECATED_IN_2_32_FOR(g_value_get_schar)
 184 gchar                 g_value_get_char          (const GValue *value);
 185 GLIB_AVAILABLE_IN_ALL
 186 void                  g_value_set_schar         (GValue       *value,
 187                                                  gint8         v_char);
 188 GLIB_AVAILABLE_IN_ALL
 189 gint8                 g_value_get_schar         (const GValue *value);
 190 GLIB_AVAILABLE_IN_ALL
 191 void                  g_value_set_uchar         (GValue       *value,
 192                                                  guchar        v_uchar);
 193 GLIB_AVAILABLE_IN_ALL
 194 guchar                g_value_get_uchar         (const GValue *value);
 195 GLIB_AVAILABLE_IN_ALL
 196 void                  g_value_set_boolean       (GValue       *value,
 197                                                  gboolean      v_boolean);
 198 GLIB_AVAILABLE_IN_ALL
 199 gboolean              g_value_get_boolean       (const GValue *value);
 200 GLIB_AVAILABLE_IN_ALL
 201 void                  g_value_set_int           (GValue       *value,
 202                                                  gint          v_int);
 203 GLIB_AVAILABLE_IN_ALL
 204 gint                  g_value_get_int           (const GValue *value);
 205 GLIB_AVAILABLE_IN_ALL
 206 void                  g_value_set_uint          (GValue       *value,
 207                                                  guint         v_uint);
 208 GLIB_AVAILABLE_IN_ALL
 209 guint                 g_value_get_uint          (const GValue *value);
 210 GLIB_AVAILABLE_IN_ALL
 211 void                  g_value_set_long          (GValue       *value,
 212                                                  glong         v_long);
 213 GLIB_AVAILABLE_IN_ALL
 214 glong                 g_value_get_long          (const GValue *value);
 215 GLIB_AVAILABLE_IN_ALL
 216 void                  g_value_set_ulong         (GValue       *value,
 217                                                  gulong        v_ulong);
 218 GLIB_AVAILABLE_IN_ALL
 219 gulong                g_value_get_ulong         (const GValue *value);
 220 GLIB_AVAILABLE_IN_ALL
 221 void                  g_value_set_int64         (GValue       *value,
 222                                                  gint64        v_int64);
 223 GLIB_AVAILABLE_IN_ALL
 224 gint64                g_value_get_int64         (const GValue *value);
 225 GLIB_AVAILABLE_IN_ALL
 226 void                  g_value_set_uint64        (GValue       *value,
 227                                                  guint64      v_uint64);
 228 GLIB_AVAILABLE_IN_ALL
 229 guint64               g_value_get_uint64        (const GValue *value);
 230 GLIB_AVAILABLE_IN_ALL
 231 void                  g_value_set_float         (GValue       *value,
 232                                                  gfloat        v_float);
 233 GLIB_AVAILABLE_IN_ALL
 234 gfloat                g_value_get_float         (const GValue *value);
 235 GLIB_AVAILABLE_IN_ALL
 236 void                  g_value_set_double        (GValue       *value,
 237                                                  gdouble       v_double);
 238 GLIB_AVAILABLE_IN_ALL
 239 gdouble               g_value_get_double        (const GValue *value);
 240 GLIB_AVAILABLE_IN_ALL
 241 void                  g_value_set_string        (GValue       *value,
 242                                                  const gchar  *v_string);
 243 GLIB_AVAILABLE_IN_ALL
 244 void                  g_value_set_static_string (GValue       *value,
 245                                                  const gchar  *v_string);
 246 GLIB_AVAILABLE_IN_ALL
 247 const gchar *         g_value_get_string        (const GValue *value);
 248 GLIB_AVAILABLE_IN_ALL
 249 gchar*                g_value_dup_string        (const GValue *value);
 250 GLIB_AVAILABLE_IN_ALL
 251 void                  g_value_set_pointer       (GValue       *value,
 252                                                  gpointer      v_pointer);
 253 GLIB_AVAILABLE_IN_ALL
 254 gpointer              g_value_get_pointer       (const GValue *value);
 255 GLIB_AVAILABLE_IN_ALL
 256 GType                 g_gtype_get_type          (void);
 257 GLIB_AVAILABLE_IN_ALL
 258 void                  g_value_set_gtype         (GValue       *value,
 259                                                  GType         v_gtype);
 260 GLIB_AVAILABLE_IN_ALL
 261 GType                 g_value_get_gtype         (const GValue *value);
 262 GLIB_AVAILABLE_IN_ALL
 263 void                  g_value_set_variant       (GValue       *value,
 264                                                  GVariant     *variant);
 265 GLIB_AVAILABLE_IN_ALL
 266 void                  g_value_take_variant      (GValue       *value,
 267                                                  GVariant     *variant);
 268 GLIB_AVAILABLE_IN_ALL
 269 GVariant*             g_value_get_variant       (const GValue *value);
 270 GLIB_AVAILABLE_IN_ALL
 271 GVariant*             g_value_dup_variant       (const GValue *value);
 272
 273
 274 /* Convenience for registering new pointer types */
 275 GLIB_AVAILABLE_IN_ALL
 276 GType                 g_pointer_type_register_static (const gchar *name);
 277
 278 /* debugging aid, describe value contents as string */
 279 GLIB_AVAILABLE_IN_ALL
 280 gchar*                g_strdup_value_contents   (const GValue *value);
 281
 282
 283 GLIB_AVAILABLE_IN_ALL
 284 void g_value_take_string                        (GValue            *value,
 285                                                  gchar             *v_string);
 286 GLIB_DEPRECATED_FOR(g_value_take_string)
 287 void g_value_set_string_take_ownership          (GValue            *value,
 288                                                  gchar             *v_string);
 289
 290
 291 /* humpf, need a C representable type name for G_TYPE_STRING */
 292 /**
 293  * gchararray:
 294  *
 295  * A C representable type name for #G_TYPE_STRING.
 296  */
 297 typedef gchar* gchararray;
 298
 299
 300 G_END_DECLS
 301
 302 #endif /* __G_VALUETYPES_H__ */