nsz Git - libfirm/blob - ir/ir/iredgeset.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  * @author    Matthias Braun
  23  * @date      12.01.2008
  24  * @brief     An edgeset.
  25  * @version   $Id$
  26  */
  27 #ifndef _FIRM_IREDGESET_H_
  28 #define _FIRM_IREDGESET_H_
  29
  30 #include "firm_config.h"
  31
  32 #include "firm_types.h"
  33
  34 #define HashSet          ir_edgeset_t
  35 #define HashSetIterator  ir_edgeset_iterator_t
  36 #define ValueType        ir_edge_t*
  37 #define DO_REHASH
  38
  39 #include "hashset.h"
  40
  41 #undef DO_REHASH
  42 #undef ValueType
  43 #undef HashSetIterator
  44 #undef HashSet
  45
  46 typedef struct ir_edgeset_t          ir_edgeset_t;
  47 typedef struct ir_edgeset_iterator_t ir_edgeset_iterator_t;
  48
  49 /**
  50  * Initializes a edgeset with default size.
  51  *
  52  * @param edgeset      Pointer to allocated space for the edgeset
  53  */
  54 void ir_edgeset_init(ir_edgeset_t *edgeset);
  55
  56 /**
  57  * Destroys a edgeset and frees the memory allocated for hashtable. The memory of
  58  * the edgeset itself is not freed.
  59  *
  60  * @param edgeset   Pointer to the edgeset
  61  */
  62 void ir_edgeset_destroy(ir_edgeset_t *edgeset);
  63
  64 /**
  65  * Inserts a edge into a edgeset.
  66  *
  67  * @param edgeset   Pointer to the edgeset
  68  * @param edge      edge to insert into the edgeset
  69  */
  70 ir_edge_t *ir_edgeset_insert(ir_edgeset_t *edgeset, ir_edge_t *edge);
  71
  72
  73 /**
  74  * Removes a edge from a edgeset. Does nothing if the edgeset doesn't contain
  75  * the edge.
  76  *
  77  * @param edgeset  Pointer to the edgeset
  78  * @param edge     Node to remove from the edgeset
  79  */
  80 void ir_edgeset_remove(ir_edgeset_t *edgeset, const ir_edge_t *edge);
  81
  82 /**
  83  * Tests whether a edgeset contains a specific edge
  84  *
  85  * @param edgeset   Pointer to the edgeset
  86  * @param edge      The pointer to find
  87  * @returns         1 if edgeset contains the edge, 0 else
  88  */
  89 int ir_edgeset_contains(const ir_edgeset_t *edgeset, const ir_edge_t *edge);
  90
  91 /**
  92  * Initializes a edgeset iterator. Sets the iterator before the first element in
  93  * the edgeset.
  94  *
  95  * @param iterator   Pointer to already allocated iterator memory
  96  * @param edgeset       Pointer to the edgeset
  97  */
  98 void ir_edgeset_iterator_init(ir_edgeset_iterator_t *iterator,
  99                               const ir_edgeset_t *edgeset);
 100
 101 /**
 102  * Advances the iterator and returns the current element or NULL if all elements
 103  * in the edgeset have been processed.
 104  * @attention It is not allowed to use edgeset_insert or edgeset_remove while
 105  *            iterating over a edgeset.
 106  *
 107  * @param iterator  Pointer to the edgeset iterator.
 108  * @returns         Next element in the edgeset or NULL
 109  */
 110 ir_edge_t *ir_edgeset_iterator_next(ir_edgeset_iterator_t *iterator);
 111
 112 /**
 113  * Removes the element the iterator currently points to
 114  *
 115  * @param edgeset   Pointer to the edgeset
 116  * @param iterator  Pointer to the edgeset iterator.
 117  */
 118 void ir_edgeset_remove_iterator(ir_edgeset_t *edgeset,
 119                                 const ir_edgeset_iterator_t *iterator);
 120
 121 #define foreach_ir_edgeset(edgeset, edge, iter) \
 122         for(ir_edgeset_iterator_init(&iter, edgeset), \
 123         edge = ir_edgeset_iterator_next(&iter);    \
 124                 edge != NULL; edge = ir_edgeset_iterator_next(&iter))
 125
 126 #endif