Fixed combo by fixing an old artefact from the older libFirm Cmp nodes.
[libfirm] / ir / adt / util.h
index c8acb56..1e93e3f 100644 (file)
@@ -1,25 +1,32 @@
-/**
- * @file   util.h
- * @date   31.05.2005
- * @author Sebastian Hack
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
  *
- * Some utility macros.
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
  *
- * Copyright (C) 2005 Universitaet Karlsruhe
- * Released under the GPL
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
-#ifndef _UTIL_H
-#define _UTIL_H
-
 /**
- * Get the offset of a member of a struct.
- * @param type   The type of the struct member is in.
- * @param member The name of the member.
- * @return       The offset of member in type in bytes.
+ * @file
+ * @date   31.05.2005
+ * @author Sebastian Hack
+ * @brief  Some utility macros.
  */
-#define offset_of(type, member) \
-  ((char *) &(((type *) 0)->member) - (char *) 0)
+#ifndef FIRM_ADT_UTIL_H
+#define FIRM_ADT_UTIL_H
+
+#include <stddef.h>
 
 /**
  * Make pointer to the struct from a pointer to a member of that struct.
  * @param member  The name of the member.
  * @return        A pointer to the struct member is in.
  */
-#define container_of(ptr, type, member) \
-       ((type *) ((char *) (ptr) - offset_of(type, member)))
+#define firm_container_of(ptr, type, member) \
+       ((type *) ((char *) (ptr) - offsetof(type, member)))
 
 /**
- * Get the number of elements of a static array.
- * @param arr The static array.
- * @return The number of elements in that array.
- */
-#define array_size(arr) \
-  (sizeof(arr) / sizeof((arr)[0]))
-
-/**
- * Asserts that the constant expression x is not zero at compiletime. name has
- * to be a unique identifier.
+ * Returns size of a static array. Warning: This returns invalid values for
+ * dynamically allocated arrays.
  *
- * @note This uses the fact, that double case labels are not allowed.
+ * @param a    static array
  */
-#define COMPILETIME_ASSERT(x, name) \
-    static __attribute__((unused)) void compiletime_assert_##name (int h) { \
-        switch(h) { case 0: case (x): ; } \
-    }
+#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
 
-#ifdef __GNUC__
-/**
- * Indicates to the compiler that the value of x is very likely 1
- * @note Only use this in speed critical code and when you are sure x is often 1
- */
-#define LIKELY(x)   __builtin_expect((x), 1)
-
-/**
- * Indicates to the compiler that it's very likely that x is 0
- * @note Only use this in speed critical code and when you are sure x is often 0
- */
-#define UNLIKELY(x) __builtin_expect((x), 0)
-#else
-#define LIKELY(x)   x
-#define UNLIKELY(x) x
 #endif
-
-#endif /* _UTIL_H */