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