Fix Doxygen tags.
[bertos.git] / macros.h
index f027ce2bee11039bac286f360d3165a15772325d..08aaa85c883289c987d573f2ea1e81551e0d1044 100755 (executable)
--- a/macros.h
+++ b/macros.h
@@ -5,51 +5,63 @@
  * This file is part of DevLib - See devlib/README for information.
  * -->
  *
- * \version $Id$
+ * \brief Common and handy function macros
  *
+ * \version $Id$
  * \author Bernardo Innocenti <bernie@develer.com>
  * \author Giovanni Bajo <rasky@develer.com>
- *
- * \brief Common and handy function macros
  */
 
-/*
- * $Log$
- * Revision 1.3  2004/08/24 14:13:48  bernie
- * Restore a few macros that were lost in the way.
- *
- * Revision 1.2  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.1  2004/08/14 19:37:57  rasky
- * Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
- *
- * Revision 1.4  2004/08/14 18:36:50  rasky
- * Doxygen fix e un livello di parentesi aggiuntivi per la macro
- *
- * Revision 1.3  2004/08/12 20:01:32  rasky
- * Aggiunte macro BIT_CHANGE e BIT_CHANGE_BV
- *
- * Revision 1.2  2004/08/10 21:36:14  rasky
- * Aggiunto include macros.h dove serve
- * Aggiunta dipendenza da compiler.h in macros.h
- *
- * Revision 1.1  2004/08/10 21:30:00  rasky
- * Estratte le funzioni macro in macros.h
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.8  2004/10/19 07:14:20  bernie
+ *#* Add macros to test for specific compiler features.
+ *#*
+ *#* Revision 1.7  2004/09/20 03:30:45  bernie
+ *#* C++ also has variadic macros.
+ *#*
+ *#* Revision 1.6  2004/09/14 21:02:04  bernie
+ *#* SWAP(), MINMAX(): New macros.
+ *#*
+ *#* Revision 1.5  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.3  2004/08/24 14:13:48  bernie
+ *#* Restore a few macros that were lost in the way.
+ *#*
+ *#* Revision 1.2  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.1  2004/08/14 19:37:57  rasky
+ *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
+ *#*
+ *#* Revision 1.4  2004/08/14 18:36:50  rasky
+ *#* Doxygen fix e un livello di parentesi aggiuntivi per la macro
+ *#*
+ *#* Revision 1.3  2004/08/12 20:01:32  rasky
+ *#* Aggiunte macro BIT_CHANGE e BIT_CHANGE_BV
+ *#*
+ *#* Revision 1.2  2004/08/10 21:36:14  rasky
+ *#* Aggiunto include macros.h dove serve
+ *#* Aggiunta dipendenza da compiler.h in macros.h
+ *#*
+ *#* Revision 1.1  2004/08/10 21:30:00  rasky
+ *#* Estratte le funzioni macro in macros.h
+ *#*
+ *#*/
 
 #ifndef MACROS_H
 #define MACROS_H
 
 #include <compiler.h>
 
-/* Type-generic macros */
-#if GNUC_PREREQ(2,0)
+#if (COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF)
+       /* Type-generic macros */
        #define ABS(n) ({ \
                __typeof__(n) _n = (n); \
                (_n < 0) ? -_n : _n; \
                (void)(&_a == &_b); /* ensure same type */ \
                (_a > _b) ? _a : _b; \
        })
-#else /* !GNUC */
+#else /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
        /* Buggy macros for inferior compilers.  */
        #define ABS(a)          (((a) < 0) ? -(a) : (a))
        #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
        #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
-#endif /* !GNUC */
+#endif /* !(COMPILER_STATEMENT_EXPRESSIONS && COMPILER_TYPEOF) */
+
+/*! Bound \a x between \a min and \a max. */
+#define MINMAX(min,x,max)  (MIN(MAX(min, x), max))
+
+#if COMPILER_TYPEOF
+       /*!
+        * Type-generic macro to swap \a a with \a b.
+        *
+        * \note Arguments are evaluated multiple times.
+        */
+       #define SWAP(a, b) \
+               do { \
+                       (void)(&(a) == &(b)); /* type check */ \
+                       typeof(a) tmp; \
+                       tmp = (a); \
+                       (a) = (b); \
+                       (b) = tmp; \
+               } while (0)
+#else /* !COMPILER_TYPEOF */
+       /* Sub-optimal implementation that only works with integral types. */
+       #define SWAP(a, b) ((a) ^= (b) ^= (a) ^= (b))
+#endif /* COMPILER_TYPEOF */
 
 #ifndef BV
-/*! Convert a bit value to a binary flag */
-#define BV(x)       (1<<(x))
+       /*! Convert a bit value to a binary flag. */
+       #define BV(x)  (1<<(x))
 #endif
 
 /*! Round up \a x to an even multiple of the 2's power \a pad */
 #define UINT32_LOG2(x) \
        ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 
-#if COMPILER_C99
-       /*! Count the number of arguments (up to 16) */
+#if COMPILER_VARIADIC_MACROS
+       /*! Count the number of arguments (up to 16). */
        #define PP_COUNT(...) \
                PP_COUNT__(__VA_ARGS__,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
        #define PP_COUNT__(a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,count,...) \
                count
 #endif
 
-/*! Issue a compilation error if the \a condition is false */
-#define STATIC_ASSERT(condition)  \
-       extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
-
-#if COMPILER_C99
+#if COMPILER_VARIADIC_MACROS
        /*!
         * \def BIT_CHANGE(reg, (mask, value), ...)
         *
         * \note This macro is available only in C99 because it makes use of variadic macros.
         * It would be possible to make up an implementation with a slightly different syntax
         * for use with C90 compilers, through Boost Preprocessor.
-        *
         */
 
        /*!
         *
         * Similar to BIT_CHANGE(), but get bits instead of masks (and applies BV() to convert
         * them to masks).
-        *
         */
 
        #define BIT_EXTRACT_FLAG_0(bit, value)  bit
        #define BIT_CHANGE(reg, ...)        BIT_CHANGE__(reg, 0, __VA_ARGS__)
        #define BIT_CHANGE_BV(reg, ...)     BIT_CHANGE__(reg, 1, __VA_ARGS__)
 
-#endif /* COMPILER_C99 */
+#endif /* COMPILER_VARIADIC_MACROS */
 
 #endif /* MACROS_H */