2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Simplified hashnap for pointer->pointer relations
23 * @author Hubert Schmid
27 #ifndef FIRM_ADT_PMAP_H
28 #define FIRM_ADT_PMAP_H
30 /** A map which maps addresses to addresses. */
31 typedef struct pmap pmap;
36 typedef struct pmap_entry {
37 const void *key; /**< The key. */
38 void *value; /**< The value. */
42 /** Creates a new empty map. */
43 pmap *pmap_create(void);
45 /** Creates a new empty map with an initial number of slots. */
46 pmap *pmap_create_ex(int slots);
49 void pmap_destroy(pmap *);
52 * Inserts a pair (key,value) into the map. If an entry with key
53 * "key" already exists, its "value" is overwritten.
55 void pmap_insert(pmap *map, const void * key, void * value);
57 /** Checks if an entry with key "key" exists. */
58 int pmap_contains(pmap *map, const void * key);
60 /** Returns the key, value pair of "key". */
61 pmap_entry * pmap_find(pmap *map, const void * key);
63 /** Returns the value of "key". */
64 void * pmap_get(pmap *map, const void * key);
66 int pmap_count(pmap *map);
69 * Returns the first entry of a map if the map is not empty.
71 pmap_entry *pmap_first(pmap *map);
74 * Returns the next entry of a map or NULL if all entries were visited.
76 pmap_entry *pmap_next(pmap *);
78 #define foreach_pmap(pmap, curr) \
79 for (curr = pmap_first(pmap); curr; curr = pmap_next(pmap))
81 /** Breaks an iteration.
82 * Must be called, if a iteration ends before p_map_next() returns NULL.
84 void pmap_break(pmap *map);