BLI_ghash.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */
 
#ifndef BLI_GHASH_H
#define BLI_GHASH_H

#ifdef __cplusplus
extern "C" {
#endif

typedef unsigned int    (*GHashHashFP)      (const void *key);
typedef int             (*GHashCmpFP)       (const void *a, const void *b);
typedef void            (*GHashKeyFreeFP)   (void *key);
typedef void            (*GHashValFreeFP)   (void *val);

typedef struct Entry {
    struct Entry *next;

    void *key, *val;
} Entry;

typedef struct GHash {
    GHashHashFP hashfp;
    GHashCmpFP  cmpfp;

    Entry **buckets;
    struct BLI_mempool *entrypool;
    int nbuckets, nentries, cursize;
} GHash;

typedef struct GHashIterator {
    GHash *gh;
    int curBucket;
    struct Entry *curEntry;
} GHashIterator;

/* *** */

GHash* BLI_ghash_new   (GHashHashFP hashfp, GHashCmpFP cmpfp, const char *info);
void   BLI_ghash_free  (GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
void   BLI_ghash_insert(GHash *gh, void *key, void *val);
void * BLI_ghash_lookup(GHash *gh, const void *key);
int    BLI_ghash_remove(GHash *gh, void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
int    BLI_ghash_haskey(GHash *gh, void *key);
int    BLI_ghash_size  (GHash *gh);

/* *** */

GHashIterator*  BLI_ghashIterator_new       (GHash *gh);
void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh);
void            BLI_ghashIterator_free      (GHashIterator *ghi);

void*           BLI_ghashIterator_getKey    (GHashIterator *ghi);
void*           BLI_ghashIterator_getValue  (GHashIterator *ghi);
void            BLI_ghashIterator_step      (GHashIterator *ghi);
int             BLI_ghashIterator_isDone    (GHashIterator *ghi);

/* *** */

unsigned int    BLI_ghashutil_ptrhash   (const void *key);
int             BLI_ghashutil_ptrcmp    (const void *a, const void *b);

unsigned int    BLI_ghashutil_strhash   (const void *key);
int             BLI_ghashutil_strcmp    (const void *a, const void *b);

unsigned int    BLI_ghashutil_inthash   (const void *ptr);
int             BLI_ghashutil_intcmp    (const void *a, const void *b);

typedef struct GHashPair {
    const void *first;
    int second;
} GHashPair;

GHashPair*      BLI_ghashutil_pairalloc (const void *first, int second);
unsigned int    BLI_ghashutil_pairhash  (const void *ptr);
int             BLI_ghashutil_paircmp   (const void *a, const void *b);
void            BLI_ghashutil_pairfree  (void *ptr);

#ifdef __cplusplus
}
#endif

#endif /* BLI_GHASH_H */