Merged silc_1_0_branch to trunk.
[silc.git] / lib / silcutil / silctypes.h
index 21b3abd186d85307af9e216ac1d5061f486dd5d9..e98bc8c82bdf47f18a85b4f0a4f7a1d0a9df2897 100644 (file)
@@ -1,10 +1,10 @@
 /*
 
-  silctypes.h 
+  silctypes.h
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2002 Pekka Riikonen
+  Copyright (C) 2002 - 2004 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
 #ifndef SILCTYPES_H
 #define SILCTYPES_H
 
+/****d* silcutil/SILCTypes/TRUE
+ *
+ * NAME
+ *
+ *    #define TRUE ...
+ *
+ * DESCRIPTION
+ *
+ *    Boolean true value indicator.
+ *
+ * SOURCE
+ */
 #ifndef TRUE
 #define TRUE 1
 #endif
+/***/
+
+/****d* silcutil/SILCTypes/FALSE
+ *
+ * NAME
+ *
+ *    #define FALSE ...
+ *
+ * DESCRIPTION
+ *
+ *    Boolean false value indicator.
+ *
+ * SOURCE
+ */
 #ifndef FALSE
 #define FALSE 0
 #endif
+/***/
+
+/****d* silcutil/SILCTypes/bool
+ *
+ * NAME
+ *
+ *    #define bool ...
+ *
+ * DESCRIPTION
+ *
+ *    Boolean value, and is 8-bits.  Represents value 0 or 1.  In
+ *    C++ code this type is defined by the C++, and this definition is
+ *    not used.
+ *
+ * SOURCE
+ */
+#ifdef SILC_MACOSX
+#define bool _Bool
+#endif
 
-/* Define offsetof */
-#ifndef offsetof
-#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
+#ifndef __cplusplus
+#ifndef bool
+#define bool unsigned char
+#endif
 #endif
+/***/
+
+#define silc_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 
 #if SILC_SIZEOF_SHORT > 2
 #error "size of the short must be 2 bytes"
@@ -171,8 +220,8 @@ typedef signed long SilcInt64;
 typedef unsigned long long SilcUInt64;
 typedef signed long long SilcInt64;
 #else
-typedef SilcUInt32 SilcUInt64; /* XXX Use Windows's own 64 bit types */
-typedef SilcInt32 SilcInt64;
+typedef unsigned __int64 SilcUInt64;
+typedef signed __int64 SilcInt64;
 #endif
 #else
 typedef SilcUInt32 SilcUInt64;
@@ -198,15 +247,11 @@ typedef SilcInt32 SilcInt64;
 typedef SilcUInt32 * void *;
 #endif
 
-#ifndef __cplusplus
-#ifndef bool
-#define bool unsigned char
-#endif
-#endif
+/* Macros */
 
-#define GET_WORD(cp) ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24    \
-                   | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16)    \
-                   | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8)     \
+#define SILC_GET_WORD(cp) ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24       \
+                   | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16)            \
+                   | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8)             \
                    | ((SilcUInt32)(SilcUInt8)(cp)[3])
 
 /****d* silcutil/SILCTypes/SILC_GET16_MSB
@@ -222,25 +267,50 @@ typedef SilcUInt32 * void *;
  * SOURCE
  */
 #define SILC_GET16_MSB(l, cp)                          \
+do {                                                   \
        (l) = ((SilcUInt32)(SilcUInt8)(cp)[0] << 8)     \
-           | ((SilcUInt32)(SilcUInt8)(cp)[1])
+           | ((SilcUInt32)(SilcUInt8)(cp)[1]);         \
+} while(0)
 /***/
 
-/****d* silcutil/SILCTypes/SILC_PUT16_MSB
+/****d* silcutil/SILCTypes/SILC_GET32_MSB
  *
  * NAME
  *
- *    #define SILC_PUT16_MSB ...
+ *    #define SILC_GET32_MSB ...
  *
  * DESCRIPTION
  *
- *    Put two 8-bit bytes, most significant bytes first.
+ *    Return four 8-bit bytes, most significant bytes first.
  *
  * SOURCE
  */
-#define SILC_PUT16_MSB(l, cp)                  \
-       (cp)[0] = l >> 8;                       \
-       (cp)[1] = l;
+#define SILC_GET32_MSB(l, cp)                          \
+do {                                                   \
+       (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24    \
+           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16)    \
+           | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8)     \
+           | ((SilcUInt32)(SilcUInt8)(cp)[3]);         \
+} while(0)
+/***/
+
+/****d* silcutil/SILCTypes/SILC_GET64_MSB
+ *
+ * NAME
+ *
+ *    #define SILC_GET64_MSB ...
+ *
+ * DESCRIPTION
+ *
+ *    Return eight 8-bit bytes, most significant bytes first.
+ *
+ * SOURCE
+ */
+#define SILC_GET64_MSB(l, cp)                                  \
+do {                                                           \
+       (l) = ((((SilcUInt64)SILC_GET_WORD((cp))) << 32) |      \
+             ((SilcUInt64)SILC_GET_WORD((cp) + 4)));           \
+} while(0)
 /***/
 
 /****d* silcutil/SILCTypes/SILC_GET16_LSB
@@ -256,44 +326,57 @@ typedef SilcUInt32 * void *;
  * SOURCE
  */
 #define SILC_GET16_LSB(l, cp)                          \
+do {                                                   \
        (l) = ((SilcUInt32)(SilcUInt8)(cp)[0])          \
-           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)
+           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8);    \
+} while(0)
 /***/
 
-/****d* silcutil/SILCTypes/SILC_PUT16_LSB
+/****d* silcutil/SILCTypes/SILC_GET32_LSB
  *
  * NAME
  *
- *    #define SILC_PUT16_LSB ...
+ *    #define SILC_GET32_LSB ...
  *
  * DESCRIPTION
  *
- *    Put two 8-bit bytes, least significant bytes first.
+ *    Return four 8-bit bytes, least significant bytes first.
  *
  * SOURCE
  */
-#define SILC_PUT16_LSB(l, cp)                  \
-       (cp)[0] = l;                            \
-       (cp)[1] = l >> 8;
+#define SILC_GET32_LSB(l, cp)                          \
+do {                                                   \
+       (l) = ((SilcUInt32)(SilcUInt8)(cp)[0])          \
+           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)     \
+           | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16)    \
+           | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24);   \
+} while(0)
+
+/* Same as upper but XOR the result always. Special purpose macro. */
+#define SILC_GET32_X_LSB(l, cp)                                \
+       (l) ^= ((SilcUInt32)(SilcUInt8)(cp)[0])         \
+           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)     \
+           | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16)    \
+           | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
 /***/
 
-/****d* silcutil/SILCTypes/SILC_GET32_MSB
+/****d* silcutil/SILCTypes/SILC_PUT16_MSB
  *
  * NAME
  *
- *    #define SILC_GET32_MSB ...
+ *    #define SILC_PUT16_MSB ...
  *
  * DESCRIPTION
  *
- *    Return four 8-bit bytes, most significant bytes first.
+ *    Put two 8-bit bytes, most significant bytes first.
  *
  * SOURCE
  */
-#define SILC_GET32_MSB(l, cp)                          \
-       (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24    \
-           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16)    \
-           | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8)     \
-           | ((SilcUInt32)(SilcUInt8)(cp)[3])
+#define SILC_PUT16_MSB(l, cp)                  \
+do {                                           \
+       (cp)[0] = (SilcUInt8)((l) >> 8);        \
+       (cp)[1] = (SilcUInt8)(l);               \
+} while(0)
 /***/
 
 /****d* silcutil/SILCTypes/SILC_PUT32_MSB
@@ -309,36 +392,50 @@ typedef SilcUInt32 * void *;
  * SOURCE
  */
 #define SILC_PUT32_MSB(l, cp)                  \
-       (cp)[0] = l >> 24;                      \
-       (cp)[1] = l >> 16;                      \
-       (cp)[2] = l >> 8;                       \
-       (cp)[3] = l;
+do {                                           \
+       (cp)[0] = (SilcUInt8)((l) >> 24);       \
+       (cp)[1] = (SilcUInt8)((l) >> 16);       \
+       (cp)[2] = (SilcUInt8)((l) >> 8);        \
+       (cp)[3] = (SilcUInt8)(l);               \
+} while(0)
 /***/
 
-/****d* silcutil/SILCTypes/SILC_GET32_LSB
+/****d* silcutil/SILCTypes/SILC_PUT64_MSB
  *
  * NAME
  *
- *    #define SILC_GET32_LSB ...
+ *    #define SILC_PUT64_MSB ...
  *
  * DESCRIPTION
  *
- *    Return four 8-bit bytes, least significant bytes first.
+ *    Put eight 8-bit bytes, most significant bytes first.
  *
  * SOURCE
  */
-#define SILC_GET32_LSB(l, cp)                          \
-       (l) = ((SilcUInt32)(SilcUInt8)(cp)[0])          \
-           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)     \
-           | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16)    \
-           | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
+#define SILC_PUT64_MSB(l, cp)                                  \
+do {                                                           \
+  SILC_PUT32_MSB((SilcUInt32)((SilcUInt64)(l) >> 32), (cp));   \
+  SILC_PUT32_MSB((SilcUInt32)(l), (cp) + 4);                   \
+} while(0)
+/***/
 
-/* Same as upper but XOR the result always. Special purpose macro. */
-#define SILC_GET32_X_LSB(l, cp)                                \
-       (l) ^= ((SilcUInt32)(SilcUInt8)(cp)[0])         \
-           | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)     \
-           | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16)    \
-           | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
+/****d* silcutil/SILCTypes/SILC_PUT16_LSB
+ *
+ * NAME
+ *
+ *    #define SILC_PUT16_LSB ...
+ *
+ * DESCRIPTION
+ *
+ *    Put two 8-bit bytes, least significant bytes first.
+ *
+ * SOURCE
+ */
+#define SILC_PUT16_LSB(l, cp)                  \
+do  {                                          \
+       (cp)[0] = (SilcUInt8)(l);               \
+       (cp)[1] = (SilcUInt8)((l) >> 8);        \
+} while(0)
 /***/
 
 /****d* silcutil/SILCTypes/SILC_PUT32_LSB
@@ -354,46 +451,135 @@ typedef SilcUInt32 * void *;
  * SOURCE
  */
 #define SILC_PUT32_LSB(l, cp)                  \
-       (cp)[0] = l;                            \
-       (cp)[1] = l >> 8;                       \
-       (cp)[2] = l >> 16;                      \
-       (cp)[3] = l >> 24;
+do {                                           \
+       (cp)[0] = (SilcUInt8)(l);               \
+       (cp)[1] = (SilcUInt8)((l) >> 8);        \
+       (cp)[2] = (SilcUInt8)((l) >> 16);       \
+       (cp)[3] = (SilcUInt8)((l) >> 24);       \
+} while(0)
 /***/
 
-/****d* silcutil/SILCTypes/SILC_GET64_MSB
+/****d* silcutil/SILCTypes/SILC_SWAB_16
  *
  * NAME
  *
- *    #define SILC_GET64_MSB ...
+ *    #define SILC_SWAB_16 ...
  *
  * DESCRIPTION
  *
- *    Return eight 8-bit bytes, most significant bytes first.
+ *    Swabs 16-bit unsigned integer byte order.
  *
  * SOURCE
  */
-#define SILC_GET64_MSB(l, cp)                          \
-       (l) = ((((SilcUInt64)GET_WORD((cp))) << 32) |   \
-             ((SilcUInt64)GET_WORD((cp) + 4)))
+#define SILC_SWAB_16(l)                                                \
+  ((SilcUInt16)(((SilcUInt16)(l) & (SilcUInt16)0x00FFU) << 8) |        \
+               (((SilcUInt16)(l) & (SilcUInt16)0xFF00U) >> 8))
 /***/
 
-/****d* silcutil/SILCTypes/SILC_PUT64_MSB
+/****d* silcutil/SILCTypes/SILC_SWAB_32
  *
  * NAME
  *
- *    #define SILC_PUT64_MSB ...
+ *    #define SILC_SWAB_32 ...
  *
  * DESCRIPTION
  *
- *    Put eight 8-bit bytes, most significant bytes first.
+ *    Swabs 32-bit unsigned integer byte order.
  *
  * SOURCE
  */
-#define SILC_PUT64_MSB(l, cp)                                  \
-do {                                                           \
-  SILC_PUT32_MSB((SilcUInt32)((SilcUInt64)(l) >> 32), (cp));   \
-  SILC_PUT32_MSB((SilcUInt32)(l), (cp) + 4);                   \
-} while(0)
+#define SILC_SWAB_32(l)                                                        \
+  ((SilcUInt32)(((SilcUInt32)(l) & (SilcUInt32)0x000000FFUL) << 24) |  \
+               (((SilcUInt32)(l) & (SilcUInt32)0x0000FF00UL) << 8)  |  \
+               (((SilcUInt32)(l) & (SilcUInt32)0x00FF0000UL) >> 8)  |  \
+               (((SilcUInt32)(l) & (SilcUInt32)0xFF000000UL) >> 24))
+/***/
+
+/****d* silcutil/SILCTypes/SILC_PTR_TO_32
+ *
+ * NAME
+ *
+ *    #define SILC_PTR_TO_32 ...
+ *
+ * DESCRIPTION
+ *
+ *    Type casts a pointer's value into a 32-bit integer.  Use this to
+ *    avoid compiler warnings when type casting pointers to integers
+ *    of different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_PTR_TO_32(_ptr__) ((SilcUInt32)(_ptr__))
+#else
+#define SILC_PTR_TO_32(_ptr__)                                                 \
+  ((SilcUInt32)((SilcUInt64)(_ptr__) & (SilcUInt32)0xFFFFFFFFUL))
+#endif
+/***/
+
+/****d* silcutil/SILCTypes/SILC_PTR_TO_64
+ *
+ * NAME
+ *
+ *    #define SILC_PTR_TO_64 ...
+ *
+ * DESCRIPTION
+ *
+ *    Type casts a pointer's value into a 64-bit integer.  Use this to
+ *    avoid compiler warnings when type casting pointers to integers
+ *    of different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_PTR_TO_64(_ptr__) ((SilcUInt64)((SilcUInt32)(_ptr__)))
+#else
+#define SILC_PTR_TO_64(_ptr__)                                                 \
+  ((SilcUInt64)((SilcUInt64)(_ptr__) & (SilcUInt32)0xFFFFFFFFUL))
+#endif
+/***/
+
+/****d* silcutil/SILCTypes/SILC_32_TO_PTR
+ *
+ * NAME
+ *
+ *    #define SILC_PTR_TO_32 ...
+ *
+ * DESCRIPTION
+ *
+ *    Type casts a 32-bit integer value into a pointer.  Use this to
+ *    avoid compiler warnings when type casting integers to pointers of
+ *    different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_32_TO_PTR(_ival__) ((void *)((SilcUInt32)(_ival__)))
+#else
+#define SILC_32_TO_PTR(_ival__) ((void *)((SilcUInt64)(_ival__)))
+#endif
+/***/
+
+/****d* silcutil/SILCTypes/SILC_64_TO_PTR
+ *
+ * NAME
+ *
+ *    #define SILC_PTR_TO_64 ...
+ *
+ * DESCRIPTION
+ *
+ *    Type casts a 64-bit integer value into a pointer.  Use this to
+ *    avoid compiler warnings when type casting integers to pointers of
+ *    different size.
+ *
+ * SOURCE
+ */
+#if SILC_SIZEOF_VOID_P < 8
+#define SILC_64_TO_PTR(_ival__)                                                \
+  ((void *)((SilcUInt32)((SilcUInt64)(_ival__) & (SilcUInt32)0xFFFFFFFFUL)))
+#else
+#define SILC_64_TO_PTR(_ival__) ((void *)((SilcUInt64)(_ival__)))
+#endif
 /***/
 
 #endif /* SILCTYPES_H */