nsz Git - libfirm/blob - include/libfirm/adt/pmap.h

   1 /*
   2  * Copyright (C) 1995-2011 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       Simplified hashnap for pointer->pointer relations
  23  * @author      Hubert Schmid
  24  * @date        09.06.2002
  25  * @version     $Id$
  26  */
  27 #ifndef FIRM_ADT_PMAP_H
  28 #define FIRM_ADT_PMAP_H
  29
  30 #include <stddef.h>
  31
  32 #include "../begin.h"
  33
  34 /**  A map which maps addresses to addresses. */
  35 typedef struct pmap pmap;
  36
  37 /**
  38  * A key, value pair.
  39  */
  40 typedef struct pmap_entry {
  41         const void *key;    /**< The key. */
  42         void *value;  /**< The value. */
  43 } pmap_entry;
  44
  45
  46 /** Creates a new empty map. */
  47 FIRM_API pmap *pmap_create(void);
  48
  49 /** Creates a new empty map with an initial number of slots. */
  50 FIRM_API pmap *pmap_create_ex(size_t slots);
  51
  52 /** Deletes a map. */
  53 FIRM_API void pmap_destroy(pmap *);
  54
  55 /**
  56  *  Inserts a pair (key,value) into the map. If an entry with key
  57  * "key" already exists, its "value" is overwritten.
  58  */
  59 FIRM_API void pmap_insert(pmap *map, const void * key, void * value);
  60
  61 /** Checks if an entry with key "key" exists. */
  62 FIRM_API int pmap_contains(pmap *map, const void * key);
  63
  64 /** Returns the key, value pair of "key". */
  65 FIRM_API pmap_entry * pmap_find(pmap *map, const void * key);
  66
  67 /** Returns the value of "key". */
  68 FIRM_API void * pmap_get(pmap *map, const void * key);
  69
  70 FIRM_API size_t pmap_count(pmap *map);
  71
  72 /**
  73  * Returns the first entry of a map if the map is not empty.
  74  */
  75 FIRM_API pmap_entry *pmap_first(pmap *map);
  76
  77 /**
  78  * Returns the next entry of a map or NULL if all entries were visited.
  79  */
  80 FIRM_API pmap_entry *pmap_next(pmap *);
  81
  82 #define foreach_pmap(pmap, curr) \
  83         for (curr = pmap_first(pmap); curr; curr = pmap_next(pmap))
  84
  85 /** Breaks an iteration.
  86  *  Must be called, if a iteration ends before p_map_next() returns NULL.
  87  */
  88 FIRM_API void pmap_break(pmap *map);
  89
  90 #include "../end.h"
  91
  92 #endif