IRQ_GETSTATE(): New macro; Rename IRQ macros for consistency.

[bertos.git] / compiler.h

diff --git a/compiler.h b/compiler.h
index 0683d7e29cca7cb5e286e9a9e9fe21b8972dcb5e..1a5d4c0ec1ed9d8cb58b55f5a6ec996c391cd85f 100755 (executable)
--- a/compiler.h
+++ b/compiler.h
@@ -6,15 +6,26 @@
  * This file is part of DevLib - See devlib/README for information.
  * -->
  *
- * \version $Id$
+ * \brief Additional support macros for compiler independance
  *
+ * \version $Id$
  * \author Bernardo Innocenti <bernie@develer.com>
- *
- * \brief Additional support macros for compiler independance
  */
 
 /*#*
  *#* $Log$
+ *#* Revision 1.24  2004/10/03 18:35:13  bernie
+ *#* Poison C++ keywords in C programs for better portability.
+ *#*
+ *#* Revision 1.23  2004/09/20 03:30:27  bernie
+ *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
+ *#*
+ *#* Revision 1.22  2004/09/14 21:03:04  bernie
+ *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
+ *#*
+ *#* Revision 1.21  2004/09/06 21:38:31  bernie
+ *#* Misc documentation and style fixes.
+ *#*
  *#* Revision 1.20  2004/08/29 21:57:58  bernie
  *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
  *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
@@ -154,16 +165,19 @@
        #define NORETURN                __attribute__((__noreturn__))
        #define UNUSED(type,arg)        __attribute__((__unused__)) type arg
        #define INLINE                  static inline __attribute__((__always_inline__))
-       #define LIKELY(x)               __builtin_expect((x), 1)
-       #define UNLIKELY(x)             __builtin_expect((x), 0)
-       #define RESTRICT                __restrict__
+       #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 RESTRICT                __restrict__
+       #define MUST_CHECK              __attribute__((warn_unused_result))
        #if GNUC_PREREQ(3,1)
-               #define DEPRECATED      __attribute__((__deprecated__))
+               #define DEPRECATED  __attribute__((__deprecated__))
        #endif
 
        #if CPU_X86
 
-               /* hack to avoid conflicts with system type */
+               /* Hack to avoid conflicts with system type */
                #define sigset_t system_sigset_t
                #include <stddef.h>
                #include <setjmp.h>
@@ -175,20 +189,26 @@
                #include <stddef.h>
                #include <stdbool.h>
 
-               /* Missing printf-family functions in avr-libc/stdio.h */
-               #include <stdarg.h>
-               #include <avr/pgmspace.h>
-               int vsprintf_P(char *buf, const char * PROGMEM fmt, va_list ap);
-
                /* Support for harvard architectures */
                #ifdef _PROGMEM
                        #define PGM_READ_CHAR(s) pgm_read_byte(s)
                        #define PGM_FUNC(x) x ## _P
-                       #define PGM_ATTR        PROGMEM
+                       #define PGM_ATTR  PROGMEM
                #endif
 
        #endif
 
+       #ifndef __cplusplus
+               /*
+                * Disallow some C++ keywords as identifiers in C programs,
+                * for improved portability.
+                */
+               #pragma GCC poison new delete class template typename
+               #pragma GCC poison private protected public operator
+               #pragma GCC poison friend mutable using namespace
+               #pragma GCC poison cin cout cerr clog
+       #endif
+
 #elif defined(__MWERKS__) && CPU_DSP56K
 
        #include <stdint.h>
@@ -232,8 +252,17 @@
 #ifndef UNLIKELY
 #define UNLIKELY(x)            x
 #endif
+#ifndef PURE_FUNC
+#define PURE_FUNC              /* nothing */
+#endif
+#ifndef CONST_FUNC
+#define CONST_FUNC             /* nothing */
+#endif
 #ifndef RESTRICT
-#define RESTRICT
+#define RESTRICT               /* nothing */
+#endif
+#ifndef MUST_CHECK
+#define MUST_CHECK             /* nothing */
 #endif
 
 /* Support for harvard architectures */
@@ -262,9 +291,11 @@
 
 /* Support for hybrid C/C++ applications. */
 #ifdef __cplusplus
+       #define EXTERN_C        extern "C"
        #define EXTERN_C_BEGIN  extern "C" {
        #define EXTERN_C_END    }
 #else
+       #define EXTERN_C        extern
        #define EXTERN_C_BEGIN  /* nothing */
        #define EXTERN_C_END    /* nothing */
 #endif
@@ -306,7 +337,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages */
        typedef unsigned short int  uint16_t;
        typedef unsigned long int   uint32_t;
        /* \} */
-#elif defined(__GNUC__) && defined(__AVR__)
+#elif defined(__GNUC__) && CPU_AVR
        /* avr-libc is weird... */
        #include <inttypes.h>
 #else
@@ -336,7 +367,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
+        * 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
         *       compiler-specific (g++ has a builtin for it).
@@ -345,9 +376,9 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages */
 #endif
 #ifndef countof
        /*!
-        * Count the number of elements in the static array \a a
+        * Count the number of elements in the static array \a a.
         *
-        * \note This macro is non-standard, but implmenents a very common idiom
+        * \note This macro is non-standard, but implements a very common idiom
         */
        #define countof(a)  (sizeof(a) / sizeof(*(a)))
 #endif