2 * Copyright (C) 1995-2011 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 hashmap for pointer->pointer relations
23 * @author Hubert Schmid
26 #ifndef FIRM_ADT_PMAP_H
27 #define FIRM_ADT_PMAP_H
35 * @defgroup pmap Pointer Map
36 * Pointer->Pointer hashmap
40 /** A map which maps addresses to addresses. */
41 typedef struct pmap pmap;
46 typedef struct pmap_entry {
47 const void *key; /**< The key. */
48 void *value; /**< The value. */
52 /** Creates a new empty map. */
53 FIRM_API pmap *pmap_create(void);
55 /** Creates a new empty map with an initial number of slots. */
56 FIRM_API pmap *pmap_create_ex(size_t slots);
59 FIRM_API void pmap_destroy(pmap *);
62 * Inserts a pair (key,value) into the map. If an entry with key
63 * "key" already exists, its "value" is overwritten.
65 FIRM_API void pmap_insert(pmap *map, const void * key, void * value);
67 /** Checks if an entry with key "key" exists. */
68 FIRM_API int pmap_contains(pmap *map, const void * key);
70 /** Returns the key, value pair of "key". */
71 FIRM_API pmap_entry *pmap_find(pmap *map, const void * key);
73 /** Returns the value of "key". */
74 FIRM_API void * pmap_get(pmap *map, const void * key);
76 #define pmap_get(type, map, key) ((type*)pmap_get(map, key))
78 /** Return number of elements in the map */
79 FIRM_API size_t pmap_count(pmap *map);
82 * Returns the first entry of a map if the map is not empty.
84 FIRM_API pmap_entry *pmap_first(pmap *map);
87 * Returns the next entry of a map or NULL if all entries were visited.
89 FIRM_API pmap_entry *pmap_next(pmap *);
92 * Iterate over all elements in the map setting curr to the current element.
94 #define foreach_pmap(pmap, curr) \
95 for (curr = pmap_first(pmap); curr; curr = pmap_next(pmap))
97 /** Breaks an iteration.
98 * Must be called, if a iteration ends before p_map_next() returns NULL.
100 FIRM_API void pmap_break(pmap *map);