Doxygen fixes.

[bertos.git] / compiler.h

diff --git a/compiler.h b/compiler.h
index e5a32f9c241b721345e184c18f7c2031d377eb45..bbceaaa8b435a4f18eeecf3471e8a90db0a5c32a 100755 (executable)
--- a/compiler.h
+++ b/compiler.h
@@ -14,6 +14,18 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.32  2004/11/16 22:42:44  bernie
+ *#* Doxygen fixes.
+ *#*
+ *#* Revision 1.31  2004/11/16 22:37:28  bernie
+ *#* IPTR: Remove obsolete definition.
+ *#*
+ *#* Revision 1.30  2004/11/16 22:30:19  bernie
+ *#* Declare fixed-size types before other types.
+ *#*
+ *#* Revision 1.29  2004/11/16 20:34:40  bernie
+ *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
+ *#*
  *#* Revision 1.28  2004/10/21 11:03:52  bernie
  *#* Typo.
  *#*
@@ -180,13 +192,16 @@
        /* GCC attributes */
        #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
        #define NORETURN                __attribute__((__noreturn__))
-       #define UNUSED(type,arg)        __attribute__((__unused__)) type arg
+       #define UNUSED_ARG(type,arg)    __attribute__((__unused__)) type arg
+       #define UNUSED_VAR(type,name)   __attribute__((__unused__)) type name
+       #define USED_VAR(type,name)     __attribute__((__used__)) type name
        #define INLINE                  static inline __attribute__((__always_inline__))
        #define LIKELY(x)               __builtin_expect(!!(x), 1)
        #define UNLIKELY(x)             __builtin_expect(!!(x), 0)
        #define PURE_FUNC               __attribute__((pure))
        #define CONST_FUNC              __attribute__((const))
        #define UNUSED_FUNC             __attribute__((unused))
+       #define USED_FUNC               __attribute__((__used__))
        #define RESTRICT                __restrict__
        #define MUST_CHECK              __attribute__((warn_unused_result))
        #if GNUC_PREREQ(3,1)
@@ -285,8 +300,15 @@
 #ifndef DEPRECATED
 #define DEPRECATED             /* nothing */
 #endif
-#ifndef UNUSED
-#define UNUSED(type,arg)       type arg
+#ifndef UNUSED_ARG
+#define UNUSED_ARG(type,arg)   type arg
+#endif
+#define UNUSED                 UNUSED_ARG /* OBSOLETE */
+#ifndef UNUSED_VAR
+#define UNUSED_VAR(type,name)  type name
+#endif
+#ifndef USED_VAR
+#define USED_VAR(type,name)    type name
 #endif
 #ifndef REGISTER
 #define REGISTER               /* nothing */
@@ -309,6 +331,9 @@
 #ifndef UNUSED_FUNC
 #define UNUSED_FUNC            /* nothing */
 #endif
+#ifndef USED_FUNC
+#define USED_FUNC              /* nothing */
+#endif
 #ifndef RESTRICT
 #define RESTRICT               /* nothing */
 #endif
@@ -352,28 +377,6 @@
 #endif
 
 
-/*
- * Standard type definitions.
- * These should be in <sys/types.h>, but many compilers lack them.
- */
-#if !(defined(size_t) || defined(_SIZE_T_DEFINED))
-       typedef unsigned int size_t;
-       typedef int ssize_t;
-#endif
-#if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
-       typedef long time_t;
-#endif /* _TIME_T_DEFINED || __time_t_defined */
-
-/*! Bulk storage large enough for both pointers or integers */
-typedef void * iptr_t;
-typedef const void * const_iptr_t;
-#define IPTR iptr_t  /* OBSOLETE */
-
-typedef long utime_t;            /*!< Type for time expressed in microseconds */
-typedef unsigned char sig_t;     /*!< Type for signal bits */
-typedef unsigned char sigset_t;  /*!< Type for signal masks */
-typedef unsigned char page_t;    /*!< Type for banked memory pages */
-
 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
        /*!
         * \name ISO C99 fixed-size types
@@ -396,6 +399,32 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages */
        #include <stdint.h>
 #endif
 
+
+/*
+ * \name Standard type definitions.
+ *
+ * These should be in <sys/types.h>, but many compilers lack them.
+ *
+ * \{
+ */
+#if !(defined(size_t) || defined(_SIZE_T_DEFINED))
+       typedef unsigned int size_t;
+       typedef int ssize_t;
+#endif
+#if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
+       typedef long time_t;
+#endif /* _TIME_T_DEFINED || __time_t_defined */
+/*\}*/
+
+/*! Bulk storage large enough for both pointers or integers. */
+typedef void * iptr_t;
+typedef const void * const_iptr_t;
+
+typedef long utime_t;            /*!< Type for time expressed in microseconds. */
+typedef unsigned char sig_t;     /*!< Type for signal bits. */
+typedef unsigned char sigset_t;  /*!< Type for signal masks. */
+typedef unsigned char page_t;    /*!< Type for banked memory pages. */
+
 /*!
  * \name Types for hardware registers.
  *
@@ -436,6 +465,6 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages */
 
 /*! Issue a compilation error if the \a condition is false */
 #define STATIC_ASSERT(condition)  \
-       extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
+       UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
 
 #endif /* DEVLIB_COMPILER_H */