gtypes.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   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 Public
  15  * 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
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_TYPES_H__
  28 #define __G_TYPES_H__
  29
  30 #include <glibconfig.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /* Provide type definitions for commonly used types.
  35  *  These are useful because a "gint8" can be adjusted
  36  *  to be 1 byte (8 bits) on all platforms. Similarly and
  37  *  more importantly, "gint32" can be adjusted to be
  38  *  4 bytes (32 bits) on all platforms.
  39  */
  40
  41 typedef char   gchar;
  42 typedef short  gshort;
  43 typedef long   glong;
  44 typedef int    gint;
  45 typedef gint   gboolean;
  46 typedef gchar* gstring;
  47
  48 typedef unsigned char   guchar;
  49 typedef unsigned short  gushort;
  50 typedef unsigned long   gulong;
  51 typedef unsigned int    guint;
  52
  53 typedef float   gfloat;
  54 typedef double  gdouble;
  55
  56 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
  57  * Since gldouble isn't used anywhere, just disable it for now */
  58
  59 #if 0
  60 #ifdef HAVE_LONG_DOUBLE
  61 typedef long double gldouble;
  62 #else /* HAVE_LONG_DOUBLE */
  63 typedef double gldouble;
  64 #endif /* HAVE_LONG_DOUBLE */
  65 #endif /* 0 */
  66
  67 typedef void* gpointer;
  68 typedef const void *gconstpointer;
  69
  70 typedef gint            (*GCompareFunc)         (gconstpointer  a,
  71                                                  gconstpointer  b);
  72 typedef void            (*GDestroyNotify)       (gpointer       data);
  73 typedef void            (*GFunc)                (gpointer       data,
  74                                                  gpointer       user_data);
  75 typedef guint           (*GHashFunc)            (gconstpointer  key);
  76 typedef void            (*GHFunc)               (gpointer       key,
  77                                                  gpointer       value,
  78                                                  gpointer       user_data);
  79
  80 /* Define some mathematical constants that aren't available
  81  * symbolically in some strict ISO C implementations.
  82  */
  83 #define G_E     2.7182818284590452354E0
  84 #define G_LN2   6.9314718055994530942E-1
  85 #define G_LN10  2.3025850929940456840E0
  86 #define G_PI    3.14159265358979323846E0
  87 #define G_PI_2  1.57079632679489661923E0
  88 #define G_PI_4  0.78539816339744830962E0
  89 #define G_SQRT2 1.4142135623730950488E0
  90
  91 /* Portable endian checks and conversions
  92  *
  93  * glibconfig.h defines G_BYTE_ORDER which expands to one of
  94  * the below macros.
  95  */
  96 #define G_LITTLE_ENDIAN 1234
  97 #define G_BIG_ENDIAN    4321
  98 #define G_PDP_ENDIAN    3412            /* unused, need specific PDP check */
  99
 100
 101 /* Basic bit swapping functions
 102  */
 103 #define GUINT16_SWAP_LE_BE_CONSTANT(val)        ((guint16) ( \
 104     (((guint16) (val) & (guint16) 0x00ffU) << 8) | \
 105     (((guint16) (val) & (guint16) 0xff00U) >> 8)))
 106 #define GUINT32_SWAP_LE_BE_CONSTANT(val)        ((guint32) ( \
 107     (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
 108     (((guint32) (val) & (guint32) 0x0000ff00U) <<  8) | \
 109     (((guint32) (val) & (guint32) 0x00ff0000U) >>  8) | \
 110     (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
 111
 112 /* Intel specific stuff for speed
 113  */
 114 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
 115 #  define GUINT16_SWAP_LE_BE_X86(val) \
 116      (__extension__                                     \
 117       ({ register guint16 __v;                          \
 118          if (__builtin_constant_p (val))                \
 119            __v = GUINT16_SWAP_LE_BE_CONSTANT (val);     \
 120          else                                           \
 121            __asm__ __const__ ("rorw $8, %w0"            \
 122                               : "=r" (__v)              \
 123                               : "0" ((guint16) (val))); \
 124         __v; }))
 125 #  define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_X86 (val))
 126 #  if !defined(__i486__) && !defined(__i586__) \
 127       && !defined(__pentium__) && !defined(__i686__) && !defined(__pentiumpro__)
 128 #     define GUINT32_SWAP_LE_BE_X86(val) \
 129         (__extension__                                          \
 130          ({ register guint32 __v;                               \
 131             if (__builtin_constant_p (val))                     \
 132               __v = GUINT32_SWAP_LE_BE_CONSTANT (val);          \
 133           else                                                  \
 134             __asm__ __const__ ("rorw $8, %w0\n\t"               \
 135                                "rorl $16, %0\n\t"               \
 136                                "rorw $8, %w0"                   \
 137                                : "=r" (__v)                     \
 138                                : "0" ((guint32) (val)));        \
 139         __v; }))
 140 #  else /* 486 and higher has bswap */
 141 #     define GUINT32_SWAP_LE_BE_X86(val) \
 142         (__extension__                                          \
 143          ({ register guint32 __v;                               \
 144             if (__builtin_constant_p (val))                     \
 145               __v = GUINT32_SWAP_LE_BE_CONSTANT (val);          \
 146           else                                                  \
 147             __asm__ __const__ ("bswap %0"                       \
 148                                : "=r" (__v)                     \
 149                                : "0" ((guint32) (val)));        \
 150         __v; }))
 151 #  endif /* processor specific 32-bit stuff */
 152 #  define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_X86 (val))
 153 #else /* !__i386__ */
 154 #  define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
 155 #  define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
 156 #endif /* __i386__ */
 157
 158 #ifdef G_HAVE_GINT64
 159 #  define GUINT64_SWAP_LE_BE_CONSTANT(val)      ((guint64) ( \
 160       (((guint64) (val) &                                               \
 161         (guint64) G_GINT64_CONSTANT(0x00000000000000ffU)) << 56) |      \
 162       (((guint64) (val) &                                               \
 163         (guint64) G_GINT64_CONSTANT(0x000000000000ff00U)) << 40) |      \
 164       (((guint64) (val) &                                               \
 165         (guint64) G_GINT64_CONSTANT(0x0000000000ff0000U)) << 24) |      \
 166       (((guint64) (val) &                                               \
 167         (guint64) G_GINT64_CONSTANT(0x00000000ff000000U)) <<  8) |      \
 168       (((guint64) (val) &                                               \
 169         (guint64) G_GINT64_CONSTANT(0x000000ff00000000U)) >>  8) |      \
 170       (((guint64) (val) &                                               \
 171         (guint64) G_GINT64_CONSTANT(0x0000ff0000000000U)) >> 24) |      \
 172       (((guint64) (val) &                                               \
 173         (guint64) G_GINT64_CONSTANT(0x00ff000000000000U)) >> 40) |      \
 174       (((guint64) (val) &                                               \
 175         (guint64) G_GINT64_CONSTANT(0xff00000000000000U)) >> 56)))
 176 #  if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
 177 #    define GUINT64_SWAP_LE_BE_X86(val) \
 178         (__extension__                                          \
 179          ({ union { guint64 __ll;                               \
 180                     guint32 __l[2]; } __r;                      \
 181             if (__builtin_constant_p (val))                     \
 182               __r.__ll = GUINT64_SWAP_LE_BE_CONSTANT (val);     \
 183             else                                                \
 184               {                                                 \
 185                 union { guint64 __ll;                           \
 186                         guint32 __l[2]; } __w;                  \
 187                 __w.__ll = ((guint64) val);                     \
 188                 __r.__l[0] = GUINT32_SWAP_LE_BE (__w.__l[1]);   \
 189                 __r.__l[1] = GUINT32_SWAP_LE_BE (__w.__l[0]);   \
 190               }                                                 \
 191           __r.__ll; }))
 192 #    define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_X86 (val))
 193 #  else /* !__i386__ */
 194 #    define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT(val))
 195 #  endif
 196 #endif
 197
 198 #define GUINT16_SWAP_LE_PDP(val)        ((guint16) (val))
 199 #define GUINT16_SWAP_BE_PDP(val)        (GUINT16_SWAP_LE_BE (val))
 200 #define GUINT32_SWAP_LE_PDP(val)        ((guint32) ( \
 201     (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
 202     (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
 203 #define GUINT32_SWAP_BE_PDP(val)        ((guint32) ( \
 204     (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
 205     (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
 206
 207 /* The G*_TO_?E() macros are defined in glibconfig.h.
 208  * The transformation is symmetric, so the FROM just maps to the TO.
 209  */
 210 #define GINT16_FROM_LE(val)     (GINT16_TO_LE (val))
 211 #define GUINT16_FROM_LE(val)    (GUINT16_TO_LE (val))
 212 #define GINT16_FROM_BE(val)     (GINT16_TO_BE (val))
 213 #define GUINT16_FROM_BE(val)    (GUINT16_TO_BE (val))
 214 #define GINT32_FROM_LE(val)     (GINT32_TO_LE (val))
 215 #define GUINT32_FROM_LE(val)    (GUINT32_TO_LE (val))
 216 #define GINT32_FROM_BE(val)     (GINT32_TO_BE (val))
 217 #define GUINT32_FROM_BE(val)    (GUINT32_TO_BE (val))
 218
 219 #ifdef G_HAVE_GINT64
 220 #define GINT64_FROM_LE(val)     (GINT64_TO_LE (val))
 221 #define GUINT64_FROM_LE(val)    (GUINT64_TO_LE (val))
 222 #define GINT64_FROM_BE(val)     (GINT64_TO_BE (val))
 223 #define GUINT64_FROM_BE(val)    (GUINT64_TO_BE (val))
 224 #endif
 225
 226 #define GLONG_FROM_LE(val)      (GLONG_TO_LE (val))
 227 #define GULONG_FROM_LE(val)     (GULONG_TO_LE (val))
 228 #define GLONG_FROM_BE(val)      (GLONG_TO_BE (val))
 229 #define GULONG_FROM_BE(val)     (GULONG_TO_BE (val))
 230
 231 #define GINT_FROM_LE(val)       (GINT_TO_LE (val))
 232 #define GUINT_FROM_LE(val)      (GUINT_TO_LE (val))
 233 #define GINT_FROM_BE(val)       (GINT_TO_BE (val))
 234 #define GUINT_FROM_BE(val)      (GUINT_TO_BE (val))
 235
 236
 237 /* Portable versions of host-network order stuff
 238  */
 239 #define g_ntohl(val) (GUINT32_FROM_BE (val))
 240 #define g_ntohs(val) (GUINT16_FROM_BE (val))
 241 #define g_htonl(val) (GUINT32_TO_BE (val))
 242 #define g_htons(val) (GUINT16_TO_BE (val))
 243
 244 /* IEEE Standard 754 Single Precision Storage Format (gfloat):
 245  *
 246  *        31 30           23 22            0
 247  * +--------+---------------+---------------+
 248  * | s 1bit | e[30:23] 8bit | f[22:0] 23bit |
 249  * +--------+---------------+---------------+
 250  * B0------------------->B1------->B2-->B3-->
 251  *
 252  * IEEE Standard 754 Double Precision Storage Format (gdouble):
 253  *
 254  *        63 62            52 51            32   31            0
 255  * +--------+----------------+----------------+ +---------------+
 256  * | s 1bit | e[62:52] 11bit | f[51:32] 20bit | | f[31:0] 32bit |
 257  * +--------+----------------+----------------+ +---------------+
 258  * B0--------------->B1---------->B2--->B3---->  B4->B5->B6->B7->
 259  */
 260 /* subtract from biased_exponent to form base2 exponent (normal numbers) */
 261 typedef union  _GDoubleIEEE754  GDoubleIEEE754;
 262 typedef union  _GFloatIEEE754   GFloatIEEE754;
 263 #define G_IEEE754_FLOAT_BIAS    (127)
 264 #define G_IEEE754_DOUBLE_BIAS   (1023)
 265 /* multiply with base2 exponent to get base10 exponent (nomal numbers) */
 266 #define G_LOG_2_BASE_10         (0.30102999566398119521)
 267 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 268 union _GFloatIEEE754
 269 {
 270   gfloat v_float;
 271   struct {
 272     guint mantissa : 23;
 273     guint biased_exponent : 8;
 274     guint sign : 1;
 275   } mpn;
 276 };
 277 union _GDoubleIEEE754
 278 {
 279   gdouble v_double;
 280   struct {
 281     guint mantissa_low : 32;
 282     guint mantissa_high : 20;
 283     guint biased_exponent : 11;
 284     guint sign : 1;
 285   } mpn;
 286 };
 287 #elif G_BYTE_ORDER == G_BIG_ENDIAN
 288 union _GFloatIEEE754
 289 {
 290   gfloat v_float;
 291   struct {
 292     guint sign : 1;
 293     guint biased_exponent : 8;
 294     guint mantissa : 23;
 295   } mpn;
 296 };
 297 union _GDoubleIEEE754
 298 {
 299   gdouble v_double;
 300   struct {
 301     guint sign : 1;
 302     guint biased_exponent : 11;
 303     guint mantissa_high : 20;
 304     guint mantissa_low : 32;
 305   } mpn;
 306 };
 307 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
 308 #error unknown ENDIAN type
 309 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
 310
 311 G_END_DECLS
 312
 313 #endif /* __G_TYPES_H__ */
 314