/*
 * hash.h - Public API for hashtables
 *
 *   Copyright (c) 2000-2016  Shiro Kawai  <shiro@acm.org>
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 *   3. Neither the name of the authors nor the names of its contributors
 *      may be used to endorse or promote products derived from this
 *      software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 *   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* This file is included from gauche.h */

#ifndef GAUCHE_HASH_H
#define GAUCHE_HASH_H

/*================================================================
 * ScmHashCore
 */

/* Hash types */
typedef enum {
    SCM_HASH_EQ,
    SCM_HASH_EQV,
    SCM_HASH_EQUAL,
    SCM_HASH_STRING,
    SCM_HASH_GENERAL,

    SCM_HASH_WORD
} ScmHashType;

typedef struct ScmHashCoreRec ScmHashCore;
typedef struct ScmHashIterRec ScmHashIter;

/* Called when the hashtable needs to calculate a hash value from
   the key given to Scm_HashCoreSearch.   Returns a hash value. */
typedef u_long ScmHashProc(const ScmHashCore *hc, intptr_t key);

/* Called when the hashtable needs to compare the given key KEY
   with an entry's key ENTRYKEY. */
typedef int    ScmHashCompareProc(const ScmHashCore *hc, intptr_t key,
                                  intptr_t entrykey);

struct ScmHashCoreRec {
    void **buckets;
    int numBuckets;
    int numEntries;
    int numBucketsLog2;
    void                 *accessfn; /* actual type hidden */
    ScmHashProc          *hashfn;
    ScmHashCompareProc   *cmpfn;
    void *data;
};

SCM_EXTERN void Scm_HashCoreInitSimple(ScmHashCore *core,
                                       ScmHashType type,
                                       unsigned int initSize,
                                       void *data);

SCM_EXTERN void Scm_HashCoreInitGeneral(ScmHashCore *core,
                                        ScmHashProc *hashfn,
                                        ScmHashCompareProc *cmpfn,
                                        unsigned int initSize,
                                        void *data);

SCM_EXTERN int  Scm_HashCoreTypeToProcs(ScmHashType type,
                                        ScmHashProc **hashfn,
                                        ScmHashCompareProc **cmpfn);

SCM_EXTERN void Scm_HashCoreCopy(ScmHashCore *dst, const ScmHashCore *src);

SCM_EXTERN ScmDictEntry *Scm_HashCoreSearch(ScmHashCore *core,
                                            intptr_t key,
                                            ScmDictOp op);

SCM_EXTERN int  Scm_HashCoreNumEntries(ScmHashCore *core);

SCM_EXTERN void Scm_HashCoreClear(ScmHashCore *core);

struct ScmHashIterRec {
    ScmHashCore *core;
    int   bucket;
    void *next;
};

SCM_EXTERN void Scm_HashIterInit(ScmHashIter *iter, ScmHashCore *core);
SCM_EXTERN ScmDictEntry *Scm_HashIterNext(ScmHashIter *iter);

/*
 * Hash functions
 */
SCM_EXTERN u_long Scm_EqHash(ScmObj obj);
SCM_EXTERN u_long Scm_EqvHash(ScmObj obj);
SCM_EXTERN u_long Scm_HashString(ScmString *str, u_long bound);
SCM_EXTERN u_long Scm_PortableHash(ScmObj obj, u_long salt);
SCM_EXTERN ScmSmallInt Scm_DefaultHash(ScmObj obj);
SCM_EXTERN u_long Scm_CombineHashValue(u_long a, u_long b);

SCM_EXTERN ScmSmallInt Scm_HashSaltRef(void);
SCM_EXTERN ScmSmallInt Scm_HashSaltSet(ScmSmallInt);
SCM_EXTERN ScmSmallInt Scm_PortableHashSalt(ScmObj newval);

SCM_EXTERN ScmObj Scm_CurrentRecursiveHash(ScmObj);

SCM_EXTERN u_long Scm_Hash(ScmObj obj); /* DEPRECATED */

/*================================================================
 * ScmHashTable
 */

struct ScmHashTableRec {
    SCM_HEADER;
    ScmHashType type;
    ScmHashCore core;
};

SCM_CLASS_DECL(Scm_HashTableClass);
#define SCM_CLASS_HASH_TABLE  (&Scm_HashTableClass)
#define SCM_HASH_TABLE(obj)   ((ScmHashTable*)(obj))
#define SCM_HASH_TABLE_P(obj)  SCM_ISA(obj, SCM_CLASS_HASH_TABLE)

#define SCM_HASH_TABLE_CORE(obj) (&SCM_HASH_TABLE(obj)->core)

SCM_EXTERN ScmObj Scm_MakeHashTableSimple(ScmHashType type,
                                          unsigned int initSize);
SCM_EXTERN ScmObj Scm_MakeHashTableFull(ScmHashProc *hashfn,
                                        ScmHashCompareProc *cmpfn,
                                        unsigned int initSize,
                                        void *data);

SCM_EXTERN ScmHashType Scm_HashTableType(ScmHashTable *tab);

SCM_EXTERN ScmObj Scm_HashTableCopy(ScmHashTable *tab);

SCM_EXTERN ScmObj Scm_HashTableRef(ScmHashTable *ht,
                                   ScmObj key, ScmObj fallback);
SCM_EXTERN ScmObj Scm_HashTableSet(ScmHashTable *ht,
                                   ScmObj key, ScmObj value, int flags);
SCM_EXTERN ScmObj Scm_HashTableDelete(ScmHashTable *ht, ScmObj key);


SCM_EXTERN ScmObj Scm_HashTableKeys(ScmHashTable *table);
SCM_EXTERN ScmObj Scm_HashTableValues(ScmHashTable *table);

SCM_EXTERN ScmObj Scm_HashTableStat(ScmHashTable *table);


/*====================================================================
 * For backward compatibility.  DEPRECATED.
 */

#define SCM_HASHTABLE(x)       SCM_HASH_TABLE(x)
#define SCM_HASHTABLEP(x)      SCM_HASH_TABLE_P(x)
#define SCM_CLASS_HASHTABLE    SCM_CLASS_HASH_TABLE
#define SCM_HASH_ADDRESS       SCM_HASH_EQ

typedef struct ScmHashEntryRec {
    void *key;
    void *value;
} ScmHashEntry;

SCM_EXTERN ScmHashEntry *Scm_HashTableGet(ScmHashTable *hash, ScmObj key);
SCM_EXTERN ScmHashEntry *Scm_HashTableAdd(ScmHashTable *hash,
                                          ScmObj key, ScmObj value);
SCM_EXTERN ScmHashEntry *Scm_HashTablePut(ScmHashTable *hash,
                                          ScmObj key, ScmObj value);

SCM_EXTERN ScmObj Scm_MakeHashTable(ScmHashProc *hashfn,
                                    ScmHashCompareProc *cmpfn,
                                    unsigned int initSize);

#endif /* GAUCHE_HASH_H */

