2 * This file is part of libFirm.
3 * Copyright (C) 2012 University of Karlsruhe.
8 * @author Matthias Braun
12 #ifndef _FIRM_IREDGESET_H_
13 #define _FIRM_IREDGESET_H_
15 #include "firm_types.h"
17 #define HashSet ir_edgeset_t
18 #define HashSetIterator ir_edgeset_iterator_t
19 #define ValueType ir_edge_t*
26 #undef HashSetIterator
29 typedef struct ir_edgeset_t ir_edgeset_t;
30 typedef struct ir_edgeset_iterator_t ir_edgeset_iterator_t;
33 * Initializes a edgeset with default size.
35 * @param edgeset Pointer to allocated space for the edgeset
37 void ir_edgeset_init(ir_edgeset_t *edgeset);
40 * Destroys a edgeset and frees the memory allocated for hashtable. The memory of
41 * the edgeset itself is not freed.
43 * @param edgeset Pointer to the edgeset
45 void ir_edgeset_destroy(ir_edgeset_t *edgeset);
48 * Inserts a edge into a edgeset.
50 * @param edgeset Pointer to the edgeset
51 * @param edge edge to insert into the edgeset
53 ir_edge_t *ir_edgeset_insert(ir_edgeset_t *edgeset, ir_edge_t *edge);
57 * Removes a edge from a edgeset. Does nothing if the edgeset doesn't contain
60 * @param edgeset Pointer to the edgeset
61 * @param edge Node to remove from the edgeset
63 void ir_edgeset_remove(ir_edgeset_t *edgeset, const ir_edge_t *edge);
66 * Tests whether a edgeset contains a specific edge
68 * @param edgeset Pointer to the edgeset
69 * @param edge The pointer to find
70 * @returns 1 if edgeset contains the edge, 0 else
72 int ir_edgeset_contains(const ir_edgeset_t *edgeset, const ir_edge_t *edge);
75 * Initializes a edgeset iterator. Sets the iterator before the first element in
78 * @param iterator Pointer to already allocated iterator memory
79 * @param edgeset Pointer to the edgeset
81 void ir_edgeset_iterator_init(ir_edgeset_iterator_t *iterator,
82 const ir_edgeset_t *edgeset);
85 * Advances the iterator and returns the current element or NULL if all elements
86 * in the edgeset have been processed.
87 * @attention It is not allowed to use edgeset_insert or edgeset_remove while
88 * iterating over a edgeset.
90 * @param iterator Pointer to the edgeset iterator.
91 * @returns Next element in the edgeset or NULL
93 ir_edge_t *ir_edgeset_iterator_next(ir_edgeset_iterator_t *iterator);
96 * Removes the element the iterator currently points to
98 * @param edgeset Pointer to the edgeset
99 * @param iterator Pointer to the edgeset iterator.
101 void ir_edgeset_remove_iterator(ir_edgeset_t *edgeset,
102 const ir_edgeset_iterator_t *iterator);
104 #define foreach_ir_edgeset(edgeset, edge, iter) \
105 for(ir_edgeset_iterator_init(&iter, edgeset), \
106 edge = ir_edgeset_iterator_next(&iter); \
107 edge != NULL; edge = ir_edgeset_iterator_next(&iter))