nsz Git - libfirm/blob - ir/adt/util.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @date   31.05.2005
  23  * @author Sebastian Hack
  24  * @brief  Miscellaneous utility macros.
  25  */
  26 #ifndef FIRM_ADT_UTIL_H
  27 #define FIRM_ADT_UTIL_H
  28
  29 #include <stddef.h>
  30
  31 /**
  32  * Make pointer to the struct from a pointer to a member of that struct.
  33  * @param ptr     The pointer to the member.
  34  * @param type    The type of the struct.
  35  * @param member  The name of the member.
  36  * @return        A pointer to the struct member is in.
  37  */
  38 #define firm_container_of(ptr, type, member) \
  39         ((type *) ((char *) (ptr) - offsetof(type, member)))
  40
  41 /**
  42  * Returns size of a static array. Warning: This returns invalid values for
  43  * dynamically allocated arrays.
  44  *
  45  * @param a    static array
  46  */
  47 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
  48
  49 #undef MIN
  50 #undef MAX
  51 #define MAX(x, y) ((x) > (y) ? (x) : (y))
  52 #define MIN(x, y) ((x) < (y) ? (x) : (y))
  53
  54 /**
  55  * Three valued compare as demanded by e.g. qsort(3)
  56  * @param c A number.
  57  * @param d Another number.
  58  * @return 0 if c == d, -1 if c < d, 1 if c > d.
  59  */
  60 #define QSORT_CMP(c, d) (((c) > (d)) - ((c) < (d)))
  61
  62 /**
  63  * convert an integer into pointer
  64  */
  65 #define INT_TO_PTR(v)   ((void *)((char *)0 + (v)))
  66
  67 /**
  68  * convert a pointer into an integer
  69  */
  70 #define PTR_TO_INT(v)   (((char *)(v) - (char *)0))
  71
  72 #endif