documentation: Update (i.e. mostly delete) information regarding current_ir_graph.

[libfirm] / include / libfirm / adt / pmap.h

diff --git a/include/libfirm/adt/pmap.h b/include/libfirm/adt/pmap.h
index 5e00eac..3bb507e 100644 (file)
--- a/include/libfirm/adt/pmap.h
+++ b/include/libfirm/adt/pmap.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -19,14 +19,24 @@
 
 /**
  * @file
- * @brief       Simplified hashnap for pointer->pointer relations
+ * @brief       Simplified hashmap for pointer->pointer relations
  * @author      Hubert Schmid
  * @date        09.06.2002
- * @version     $Id$
  */
 #ifndef FIRM_ADT_PMAP_H
 #define FIRM_ADT_PMAP_H
 
+#include <stddef.h>
+
+#include "../begin.h"
+
+/**
+ * @ingroup adt
+ * @defgroup pmap Pointer Map
+ * Pointer->Pointer hashmap
+ * @{
+ */
+
 /**  A map which maps addresses to addresses. */
 typedef struct pmap pmap;
 
@@ -40,47 +50,64 @@ typedef struct pmap_entry {
 
 
 /** Creates a new empty map. */
-pmap *pmap_create(void);
+FIRM_API pmap *pmap_create(void);
 
 /** Creates a new empty map with an initial number of slots. */
-pmap *pmap_create_ex(int slots);
+FIRM_API pmap *pmap_create_ex(size_t slots);
 
 /** Deletes a map. */
-void pmap_destroy(pmap *);
+FIRM_API void pmap_destroy(pmap *);
 
 /**
  *  Inserts a pair (key,value) into the map. If an entry with key
  * "key" already exists, its "value" is overwritten.
  */
-void pmap_insert(pmap *map, const void * key, void * value);
+FIRM_API void pmap_insert(pmap *map, const void * key, void * value);
 
 /** Checks if an entry with key "key" exists. */
-int pmap_contains(pmap *map, const void * key);
+FIRM_API int pmap_contains(pmap *map, const void * key);
 
 /** Returns the key, value pair of "key". */
-pmap_entry * pmap_find(pmap *map, const void * key);
+FIRM_API pmap_entry *pmap_find(pmap *map, const void * key);
 
 /** Returns the value of "key". */
-void * pmap_get(pmap *map, const void * key);
+FIRM_API void * pmap_get(pmap *map, const void * key);
+
+/**
+ * Returns the value of "key".
+ * This is a wrapper for pmap_get(pmap *map); It allows to express the
+ * intended type of the set elements (instead of weakly typed void*).
+ */
+#define pmap_get(type, map, key) ((type*)pmap_get(map, key))
 
-int pmap_count(pmap *map);
+/** Return number of elements in the map */
+FIRM_API size_t pmap_count(pmap *map);
 
 /**
  * Returns the first entry of a map if the map is not empty.
  */
-pmap_entry *pmap_first(pmap *map);
+FIRM_API pmap_entry *pmap_first(pmap *map);
 
 /**
  * Returns the next entry of a map or NULL if all entries were visited.
  */
-pmap_entry *pmap_next(pmap *);
+FIRM_API pmap_entry *pmap_next(pmap *);
 
+/**
+ * Iterate over all elements in the map setting curr to the current element.
+ */
 #define foreach_pmap(pmap, curr) \
        for (curr = pmap_first(pmap); curr; curr = pmap_next(pmap))
 
 /** Breaks an iteration.
  *  Must be called, if a iteration ends before p_map_next() returns NULL.
  */
-void pmap_break(pmap *map);
+FIRM_API void pmap_break(pmap *map);
+
+/**
+ * @}
+ */
+
+#include "../end.h"
 
 #endif