nsz Git - libfirm/blob - include/libfirm/adt/eset.h

   1 /*
   2  * Copyright (C) 1995-2011 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  * @brief       a pointer hashset (WARNING: deprecated, use hashset_new.*
  23  *              instead)
  24  * @author      Hubert Schmid
  25  * @date        09.06.2002
  26  * @deprecated
  27  */
  28 #ifndef FIRM_ADT_ESET_H
  29 #define FIRM_ADT_ESET_H
  30
  31 #include <stddef.h>
  32
  33 #include "../begin.h"
  34
  35 /**
  36  * "eset" is a set of addresses. The addresses are used for element
  37  * compare and hash calculation.
  38  * The value "NULL" can not be stored, as it is used as internal sentinel.
  39  */
  40 typedef struct eset eset;
  41
  42 /** Creates a new empty set. */
  43 FIRM_API eset *eset_create(void);
  44
  45 /**
  46  * Creates a copy of the given set. Does NOT work if NULL is contained in source. */
  47 FIRM_API eset *eset_copy(eset *source);
  48
  49 /** Deletes a set. */
  50 FIRM_API void eset_destroy(eset *s);
  51
  52 /** Returns the number of elements in the set. */
  53 FIRM_API size_t eset_count(eset *s);
  54
  55 /** Inserts an address into the set. */
  56 FIRM_API void eset_insert(eset *s, void *p);
  57
  58 /** Checks, whether an address is element of a set. */
  59 FIRM_API int eset_contains(eset *s, void *p);
  60
  61 /**
  62  * Starts the iteration over a set and returns the first element or NULL
  63  * if the set is empty.
  64  *
  65  * @note: It is NOT possible to add new elements while iterating through a set.
  66  */
  67 FIRM_API void *eset_first(eset *s);
  68
  69 /**
  70  * Continues iteration through a set and returns the next element or NULL if the
  71  * iteration is finished.
  72  *
  73  * @note: It is NOT possible to add new elements while iterating through a set.
  74  */
  75 FIRM_API void *eset_next(eset *s);
  76
  77 /** Inserts all elements of source into target (union).  Does NOT work if NULL is contained in source. */
  78 FIRM_API void eset_insert_all(eset *target, eset *source);
  79
  80 #define eset_foreach(eset, type, iter) \
  81         for ((iter) = (type)eset_first((eset)); (iter) != NULL; (iter) = (type)eset_next((eset)))
  82
  83 #include "../end.h"
  84
  85 #endif