/****************************************************************************
    Copyright (C) 1987-2005 by Jeffery P. Hansen

    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., 675 Mass Ave, Cambridge, MA 02139, USA.
****************************************************************************/
/*
    Data structure and initilization for the hash table.  The hash table is
    used to look up circuit elements by name.  This is used durring the download
    phase and when setting and deleting scope probes.

*/
#ifndef __hash_h
#define __hash_h

#define INITIAL_HASHSIZE	32
#define HASH_MAXLOAD		4

typedef unsigned long nkey_t;
typedef unsigned long hashcode_t;

typedef struct hash_elem_str {
  union {
    char  		*s;
    nkey_t	  	d;
  } 			key;
  hashcode_t		hashcode;
  void			*value;
  struct hash_elem_str	*next;
} HashElem;

typedef struct {
  unsigned	size;		/* Number of hash buckets (must be power of 2) */
  unsigned	mask;		/* Mask for hash addressed (size-1) */
  unsigned	num;		/* Number of elements in hash */
  int		loop_ok;	/* OK to use Hash_next() */
  HashElem	**elems;
} Hash;

typedef Hash SHash;
typedef Hash NHash;

typedef void HashElemDelFunc(HashElem*);
void SHashElem_uninit(HashElem*);
#define HashElem_obj(E)		(E)->value
#define SHashElem_key(E)	(E)->key.s
#define NHashElem_key(E)	(E)->key.d


Hash *new_Hash();
void delete_Hash(Hash*,HashElemDelFunc*);
void Hash_init(Hash*);
void Hash_uninit(Hash*,HashElemDelFunc*);
#define Hash_numElems(H)	(H)->num

HashElem *Hash_first(Hash*);
HashElem *Hash_next(Hash*,HashElem*);
void Hash_flush(Hash *H,HashElemDelFunc *hdel);


#define new_SHash()	((SHash*)new_Hash())
#define delete_SHash(H)	delete_Hash(H,SHashElem_uninit)
#define SHash_init(H)	Hash_init(H)
#define SHash_uninit(H)	Hash_uninit(H,SHashElem_uninit)
void *SHash_find(Hash*,const char*);
int SHash_insert(Hash*,const char*,void*);
int SHash_replace(Hash*,const char*,void*);
int SHash_remove(Hash*,const char*);
#define SHash_flush(H)	Hash_flush(H,SHashElem_uninit)

#define new_NHash()	((NHash*)new_Hash())
#define delete_NHash(H)	delete_Hash(H,0)
#define NHash_init(H)	Hash_init(H)
#define NHash_uninit(H)	Hash_uninit(H,0)
void *NHash_find(Hash*,nkey_t);
int NHash_insert(Hash*,nkey_t,void*);
int NHash_remove(Hash*,nkey_t);
#define NHash_flush(H)	Hash_flush(H,0)

#endif