pmap.h

Go to the documentation of this file.

/*
 * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

#ifndef FIRM_ADT_PMAP_H
#define FIRM_ADT_PMAP_H

#include <stddef.h>

#include "../begin.h"

typedef struct pmap pmap;

typedef struct pmap_entry {
    const void *key;    
    void *value;  
} pmap_entry;


FIRM_API pmap *pmap_create(void);

FIRM_API pmap *pmap_create_ex(size_t slots);

FIRM_API void pmap_destroy(pmap *);

FIRM_API void pmap_insert(pmap *map, const void * key, void * value);

FIRM_API int pmap_contains(pmap *map, const void * key);

FIRM_API pmap_entry *pmap_find(pmap *map, const void * key);

FIRM_API void * pmap_get(pmap *map, const void * key);

#define pmap_get(type, map, key) ((type*)pmap_get(map, key))

FIRM_API size_t pmap_count(pmap *map);

FIRM_API pmap_entry *pmap_first(pmap *map);

FIRM_API pmap_entry *pmap_next(pmap *);

#define foreach_pmap(pmap, curr) \
    for (curr = pmap_first(pmap); curr; curr = pmap_next(pmap))

FIRM_API void pmap_break(pmap *map);

#include "../end.h"

#endif