Typo.
[bertos.git] / cfg / compiler.h
index 78a63bdcb449f7726856853d4dd4407b939bb5a7..9f5462b3aa8ccacfc5c9f6ecb9fd5686c3bcd0fb 100755 (executable)
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
 
 /*#*
  *#* $Log$
+ *#* Revision 1.22  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.21  2006/07/19 12:53:43  bernie
+ *#* Prune log.
+ *#*
+ *#* Revision 1.20  2006/06/10 05:36:15  bernie
+ *#* Convert to new Doxygen comments.
+ *#*
+ *#* Revision 1.19  2006/04/11 00:07:33  bernie
+ *#* Implemenent MF_SAVESEL flag.
+ *#*
  *#* Revision 1.18  2006/03/22 13:34:34  bernie
  *#* MSVC support.
  *#*
  *#*
  *#* Revision 1.1  2005/04/11 19:04:13  bernie
  *#* Move top-level headers to cfg/ subdir.
- *#*
- *#* Revision 1.44  2005/03/29 06:39:59  bernie
- *#* setjmp.h, time_t: Remove ancient retrocompatibility; Remove MSVC double to float hack.
- *#*
- *#* Revision 1.43  2005/03/01 23:15:12  bernie
- *#* Remove compatibility hack.
- *#*
- *#* Revision 1.42  2005/02/16 20:28:46  bernie
- *#* Move PGM macros to mware/pgm.h
- *#*
- *#* Revision 1.41  2005/01/22 04:19:22  bernie
- *#* MTIME_INFINITE: New constant.
- *#*
- *#* Revision 1.40  2005/01/20 18:46:04  aleph
- *#* Add progmem datatypes; PSTR() definition.
  *#*/
 #ifndef DEVLIB_COMPILER_H
 #define DEVLIB_COMPILER_H
 #endif
 
 
-/*! Concatenate two different preprocessor tokens (allowing macros to expand) */
+/** Concatenate two different preprocessor tokens (allowing macros to expand) */
 #define PP_CAT(x,y)         PP_CAT__(x,y)
 #define PP_CAT__(x,y)       x ## y
 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 
-/*! String-ize a token (allowing macros to expand) */
+/** String-ize a token (allowing macros to expand) */
 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 #define PP_STRINGIZE__(x)   #x
 
 
 /* Defaults for compiler extensions. */
 
-/*!
+/**
  * \def COMPILER_VARIADIC_MACROS
  * Support for macros with variable arguments.
  */
 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
 #endif
 
-/*!
+/**
  * \def COMPILER_TYPEOF
  * Support for dynamic type identification.
  */
 #define COMPILER_TYPEOF 0
 #endif
 
-/*!
+/**
  * \def COMPILER_STATEMENT_EXPRESSIONS
  * Support for statement expressions.
  */
        #define EXTERN_C_BEGIN  extern "C" {
        #define EXTERN_C_END    }
        #define EXTERN_CONST    extern const
+       #define CONST_CAST(TYPE,EXPR)   (const_cast<TYPE>(EXPR))
 #else
        #define EXTERN_C        extern
        #define EXTERN_C_BEGIN  /* nothing */
        #define EXTERN_C_END    /* nothing */
        #define EXTERN_CONST    const
+       #define CONST_CAST(TYPE,EXPR)   ((TYPE)(EXPR)) /* FIXME: How can we suppress the warning in C? */
 #endif
 
 
 #if defined(_MSC_VER) \
        || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
-       /*!
+       /**
         * \name ISO C99 fixed-size types
         *
         * These should be in <stdint.h>, but a few compilers lack them.
         * The ATmega8 has a very small Flash, so we can't afford
         * to link in support routines for 32bit integer arithmetic.
         */
-       typedef int16_t ticks_t;  /*!< Type for time expressed in ticks. */
-       typedef int16_t mtime_t;  /*!< Type for time expressed in milliseconds. */
-       typedef int16_t utime_t;  /*!< Type for time expressed in microseconds. */
+       typedef int16_t ticks_t;  /**< Type for time expressed in ticks. */
+       typedef int16_t mtime_t;  /**< Type for time expressed in milliseconds. */
+       typedef int16_t utime_t;  /**< Type for time expressed in microseconds. */
        #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
        #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
        #define MTIME_INFINITE 0x7FFFL
 #else
-       typedef int32_t ticks_t;  /*!< Type for time expressed in ticks. */
-       typedef int32_t mtime_t;  /*!< Type for time expressed in milliseconds. */
-       typedef int32_t utime_t;  /*!< Type for time expressed in microseconds. */
+       typedef int32_t ticks_t;  /**< Type for time expressed in ticks. */
+       typedef int32_t mtime_t;  /**< Type for time expressed in milliseconds. */
+       typedef int32_t utime_t;  /**< Type for time expressed in microseconds. */
        #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
        #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
        #define MTIME_INFINITE 0x7FFFFFFFL
 #endif
 
-/*! Bulk storage large enough for both pointers or integers. */
+/** Bulk storage large enough for both pointers or integers. */
 typedef void * iptr_t;
 
-/*! Bulk storage large enough for both pointers to constants or integers. */
+/** Bulk storage large enough for both pointers to constants or integers. */
 typedef const void * const_iptr_t;
 
-typedef unsigned char sigbit_t;  /*!< Type for signal bits. */
-typedef unsigned char sigmask_t; /*!< Type for signal masks. */
-typedef unsigned char page_t;    /*!< Type for banked memory pages. */
+typedef unsigned char sigbit_t;  /**< Type for signal bits. */
+typedef unsigned char sigmask_t; /**< Type for signal masks. */
+typedef unsigned char page_t;    /**< Type for banked memory pages. */
 
 
-/*!
+/**
  * \name Standard type definitions.
  *
  * These should be in <sys/types.h> or <stddef.h>, but many compilers
@@ -478,7 +477,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 /*\}*/
 
 
-/*!
+/**
  * \name Types for hardware registers.
  *
  * Only use these types for registers whose contents can
@@ -499,7 +498,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 
 /* Quasi-ANSI macros */
 #ifndef offsetof
-       /*!
+       /**
         * Return the byte offset of the member \a m in struct \a s.
         *
         * \note This macro should be defined in "stddef.h" and is sometimes
@@ -508,7 +507,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
        #define offsetof(s,m)  (size_t)&(((s *)0)->m)
 #endif
 #ifndef countof
-       /*!
+       /**
         * Count the number of elements in the static array \a a.
         *
         * \note This macro is non-standard, but implements a very common idiom
@@ -533,12 +532,12 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
                ( (type *)((char *)(ptr) - offsetof(type, member)) )
 #endif
 
-/*! Issue a compilation error if the \a condition is false */
+/** Issue a compilation error if the \a condition is false */
 #define STATIC_ASSERT(condition)  \
        UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
 
 #ifndef ASSERT_TYPE_EQUAL
-/*! Ensure two variables have the same type. */
+/** Ensure two variables have the same type. */
 #define ASSERT_TYPE_EQUAL(var1, var2)  \
                do { (void)(&(var1) == &(var2)); } while(0)
 #endif