X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=compiler.h;h=bbceaaa8b435a4f18eeecf3471e8a90db0a5c32a;hb=0480653a2b43a2fb4892016d6e8ea7607eae2611;hp=d0049e38186b3459e6e8233b85854e87c34eb61c;hpb=ea4ef51b306fde6480c03f72e81c4b31d51660f6;p=bertos.git diff --git a/compiler.h b/compiler.h index d0049e38..bbceaaa8 100755 --- a/compiler.h +++ b/compiler.h @@ -6,72 +6,95 @@ * 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 - * - * \brief Additional support macros for compiler independance */ -/* - * $Log$ - * Revision 1.16 2004/08/14 19:37:57 rasky - * Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc. - * - * Revision 1.15 2004/08/13 03:23:26 bernie - * Adjust a few MSVC tweaks from older projects. - * - * Revision 1.14 2004/08/10 06:56:29 bernie - * RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file. - * - * Revision 1.13 2004/08/02 20:20:29 aleph - * Merge from project_ks - * - * Revision 1.12 2004/08/01 01:21:17 bernie - * LIKELY(), UNLIKELY(): New compiler-specific macros. - * - * Revision 1.11 2004/07/30 14:34:10 rasky - * Vari fix per documentazione e commenti - * Aggiunte PP_CATn e STATIC_ASSERT - * - * Revision 1.10 2004/07/30 14:15:53 rasky - * Nuovo supporto unificato per detect della CPU - * - * Revision 1.9 2004/07/29 22:57:09 bernie - * vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers. - * - * Revision 1.8 2004/07/20 23:43:39 bernie - * Use attribute((always_inline)) to force inlining. This fixes the much - * hated need of redundant prototypes for inline functions. - * - * Revision 1.7 2004/07/20 23:26:48 bernie - * Fix two errors introduced by previous commit. - * - * Revision 1.6 2004/07/20 23:12:43 bernie - * *** empty log message *** - * - * Revision 1.5 2004/07/20 17:08:03 bernie - * Cleanup documentation - * - * Revision 1.4 2004/06/27 15:20:26 aleph - * Change UNUSED() macro to accept two arguments: type and name; - * Add macro GNUC_PREREQ to detect GCC version during build; - * Some spacing cleanups and typo fix - * - * Revision 1.3 2004/06/06 18:00:39 bernie - * PP_CAT(): New macro. - * - * Revision 1.2 2004/06/03 11:27:09 bernie - * Add dual-license information. - * - * Revision 1.1 2004/05/23 17:48:35 bernie - * Add top-level files. - * - */ -#ifndef COMPILER_H -#define COMPILER_H +/*#* + *#* $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. + *#* + *#* Revision 1.27 2004/10/21 10:09:40 bernie + *#* Remove spurious token in preprocessor directive. + *#* + *#* Revision 1.26 2004/10/19 08:55:14 bernie + *#* UNUSED_FUNC: New function attribute. + *#* + *#* Revision 1.25 2004/10/19 07:14:20 bernie + *#* Add macros to test for specific compiler features. + *#* + *#* 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. + *#* + *#* Revision 1.19 2004/08/25 14:12:08 rasky + *#* Aggiornato il comment block dei log RCS + *#* + *#* Revision 1.18 2004/08/24 16:32:37 bernie + *#* Document custom types. + *#* + *#* Revision 1.17 2004/08/24 13:32:14 bernie + *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h; + *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere; + *#* Trim CVS log; + *#* Rename header guards; + *#* Don't include arch_config.h in compiler.h as it's not needed there. + *#* + *#* Revision 1.16 2004/08/14 19:37:57 rasky + *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc. + *#* + *#* Revision 1.15 2004/08/13 03:23:26 bernie + *#* Adjust a few MSVC tweaks from older projects. + *#* + *#* Revision 1.14 2004/08/10 06:56:29 bernie + *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file. + *#* + *#* Revision 1.13 2004/08/02 20:20:29 aleph + *#* Merge from project_ks + *#* + *#* Revision 1.12 2004/08/01 01:21:17 bernie + *#* LIKELY(), UNLIKELY(): New compiler-specific macros. + *#* + *#* Revision 1.11 2004/07/30 14:34:10 rasky + *#* Vari fix per documentazione e commenti + *#* Aggiunte PP_CATn e STATIC_ASSERT + *#* + *#* Revision 1.10 2004/07/30 14:15:53 rasky + *#* Nuovo supporto unificato per detect della CPU + *#* + *#* Revision 1.9 2004/07/29 22:57:09 bernie + *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers. + *#*/ +#ifndef DEVLIB_COMPILER_H +#define DEVLIB_COMPILER_H -#include "arch_config.h" #include "cpu_detect.h" @@ -88,6 +111,19 @@ #define COMPILER_C99 0 #endif + +/*! 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) */ +#define PP_STRINGIZE(x) PP_STRINGIZE__(x) +#define PP_STRINGIZE__(x) #x + + #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__) #pragma language=extended #define INTERRUPT(x) interrupt [x] @@ -148,21 +184,33 @@ #elif defined(__GNUC__) + /* Compiler features */ + #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */ + #define COMPILER_TYPEOF 1 + #define COMPILER_STATEMENT_EXPRESSIONS 1 + /* 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 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 UNUSED_FUNC __attribute__((unused)) + #define USED_FUNC __attribute__((__used__)) + #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 #include @@ -174,22 +222,32 @@ #include #include - /* Missing printf-family functions in avr-libc/stdio.h */ - #include - #include - 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 + /* Compiler features */ + #define COMPILER_TYPEOF 1 + #define COMPILER_STATEMENT_EXPRESSIONS 1 + #include #include #include @@ -203,6 +261,32 @@ #endif +/* Defaults for compiler extensions. */ + +/*! + * \def COMPILER_VARIADIC_MACROS + * Support for macros with variable arguments. + */ +#ifndef COMPILER_HAVE_VARIADIC_MACROS +#define COMPILER_HAVE_VARIADIC_MACROS (COMPILER_C99 != 0) +#endif + +/*! + * \def COMPILER_TYPEOF + * Support for macros with variable arguments. + */ +#ifndef COMPILER_TYPEOF +#define COMPILER_TYPEOF 0 +#endif + +/*! + * \def COMPILER_STATEMENT_EXPRESSIONS + * Support for macros with variable arguments. + */ +#ifndef COMPILER_STATEMENT_EXPRESSIONS +#define COMPILER_STATEMENT_EXPRESSIONS 0 +#endif + /* A few defaults for missing compiler features. */ #ifndef INLINE #define INLINE static inline @@ -216,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 */ @@ -231,8 +322,23 @@ #ifndef UNLIKELY #define UNLIKELY(x) x #endif +#ifndef PURE_FUNC +#define PURE_FUNC /* nothing */ +#endif +#ifndef CONST_FUNC +#define CONST_FUNC /* nothing */ +#endif +#ifndef UNUSED_FUNC +#define UNUSED_FUNC /* nothing */ +#endif +#ifndef USED_FUNC +#define USED_FUNC /* nothing */ +#endif #ifndef RESTRICT -#define RESTRICT +#define RESTRICT /* nothing */ +#endif +#ifndef MUST_CHECK +#define MUST_CHECK /* nothing */ #endif /* Support for harvard architectures */ @@ -252,7 +358,7 @@ /* Misc definitions */ #ifndef NULL -#define NULL 0 +#define NULL (void *)0 #endif #ifndef EOF #define EOF (-1) @@ -261,38 +367,22 @@ /* 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 -/* - * Standard type definitions - * These should be in , 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 */ - -/*! Storage for pointers and integers */ -#define IPTR void * - -typedef long utime_t; -typedef unsigned char sig_t; -typedef unsigned char sigset_t; -typedef unsigned char page_t; - #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) - /* - * ISO C99 fixed-size types + /*! + * \name ISO C99 fixed-size types + * * These should be in , but many compilers lack them. + * \{ */ typedef signed char int8_t; typedef short int int16_t; @@ -300,8 +390,8 @@ typedef unsigned char page_t; typedef unsigned char uint8_t; typedef unsigned short int uint16_t; typedef unsigned long int uint32_t; -#elif defined(__AVR__) - /* TODO: should this detect GCC+AVR combo, or just CPU_AVR? */ + /* \} */ +#elif defined(__GNUC__) && CPU_AVR /* avr-libc is weird... */ #include #else @@ -309,6 +399,32 @@ typedef unsigned char page_t; #include #endif + +/* + * \name Standard type definitions. + * + * These should be in , 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. * @@ -327,4 +443,28 @@ typedef unsigned char page_t; #endif /*\}*/ -#endif /* COMPILER_H */ + +/* 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 + * compiler-specific (g++ has a builtin for it). + */ + #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 + */ + #define countof(a) (sizeof(a) / sizeof(*(a))) +#endif + +/*! Issue a compilation error if the \a condition is false */ +#define STATIC_ASSERT(condition) \ + UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]) + +#endif /* DEVLIB_COMPILER_H */