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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/adt/eset.c
   4  * Purpose:     Datentyp: Vereinfachte Map (hash-map) zum Speichern von
   5  *              Zeigern/Adressen -> Zeigern/Adressen.
   6  * Author:      Hubert Schmid
   7  * Modified by:
   8  * Created:     09.06.2002
   9  * CVS-ID:      $Id$
  10  * Copyright:   (c) 2002 Universität Karlsruhe
  11  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  12  */
  13
  14 #ifndef _PMAP_H_
  15 #define _PMAP_H_
  16
  17
  18 #include <stdbool.h>
  19
  20
  21 /* Map die Adressen auf Adressen abbildet. Der Vergleich und das
  22  * Hashen findet über die Adresse statt. */
  23
  24 typedef struct pmap pmap;
  25
  26 typedef struct pmap_entry {
  27   void * key;
  28   void * value;
  29 } pmap_entry;
  30
  31
  32 /* Erzeugt eine neue leere Map. */
  33 pmap * pmap_create(void);
  34
  35 /* Löscht eine Map. */
  36 void pmap_destroy(pmap *);
  37
  38 /* Fügt ein Paar (key,value) in die Map ein. Gibt es bereits einen
  39  * Eintrag mit "key" in er Map, so wird der entsprechende "value"
  40  * überschrieben. */
  41 void pmap_insert(pmap *, void * key, void * value);
  42
  43 /* Prüft ob ein Eintrag zu "key" exisitiert. */
  44 bool pmap_contains(pmap *, void * key);
  45
  46 /* Gibt den Eintrag zu "key" zurück. */
  47 pmap_entry * pmap_find(pmap *, void * key);
  48
  49 /* Gibt für den Eintrag zu "key" den "value" zurück. */
  50 void * pmap_get(pmap *, void * key);
  51
  52 /* Mit den Funktionen "pmap_first" und "pmap_next" kann man durch die
  53  * Map iterieren. Die Funktionen geben einen Zeiger auf einen Eintrag
  54  * zurück (key,value). Die Funktionen geben "NULL" zurück, wenn kein
  55  * weiterer Eintrag existiert. */
  56 pmap_entry * pmap_first(pmap *);
  57 pmap_entry * pmap_next(pmap *);
  58
  59
  60 #endif /* _PMAP_H_ */