* 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.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.
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.33 2004/11/16 23:09:40 bernie
+ *#* size_t: Add 64bit definitions; time_t: Add 16bit hack for tiny CPUs.
+ *#*
+ *#* 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
#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 <stddef.h>
#include <setjmp.h>
#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
+ /* Compiler features */
+ #define COMPILER_TYPEOF 1
+ #define COMPILER_STATEMENT_EXPRESSIONS 1
+
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#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
#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 */
#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 */
/* 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 <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 */
-
-/*! Storage for pointers and integers */
-/* FIXME: turn this into a typedef? */
-#define IPTR void *
-
-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
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
#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))
+ #if CPU_REG_BITS > 32
+ /* 64bit. */
+ typedef unsigned long size_t;
+ typedef long ssize_t;
+ #else
+ /* 32bit or 16bit. */
+ typedef unsigned int size_t;
+ typedef int ssize_t;
+ #endif
+#endif
+#if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
+ /*
+ * The ATmega8 has a very small Flash, so we can't afford to
+ * link in support routines for 32bit integer arithmetic.
+ */
+ #if CPU_AVR_ATMEGA8
+ typedef int time_t; /* 16bit. */
+ #define SIZEOF_TIME_T SIZEOF_INT
+ #else
+ typedef long time_t; /* 32bit or 64bit. */
+ #define SIZEOF_TIME_T SIZEOF_LONG
+ #endif
+#else
+ /* Just a guess, but quite safe. */
+ #define SIZEOF_TIME_T SIZEOF_LONG
+#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.
*
/* 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).
#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
+/*! 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 */