HashTable.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/Object.h>
 
typedef struct HashTable HashTable;
typedef struct HashTableInterface HashTableInterface;
 
typedef size_t (*HashTableHashFunc)(const ident key);
 
typedef bool (*HashTableEqualFunc)(const ident a, const ident b);
 
typedef void (*HashTableEnumerator)(const HashTable *table, ident key, ident value, ident data);
 
OBJECTIVELY_EXPORT size_t HashTableHashStr(const ident key);
OBJECTIVELY_EXPORT bool   HashTableEqualStr(const ident a, const ident b);
OBJECTIVELY_EXPORT size_t HashTableHashStri(const ident key);
OBJECTIVELY_EXPORT bool   HashTableEqualStri(const ident a, const ident b);
OBJECTIVELY_EXPORT size_t HashTableHashDirect(const ident key);
OBJECTIVELY_EXPORT bool   HashTableEqualDirect(const ident a, const ident b);
 
typedef struct HashTableEntry {
  ident key;
  ident value;
  struct HashTableEntry *next;
} HashTableEntry;
 
struct HashTable {
 
  Object object;
 
  HashTableInterface *interface;
 
  size_t count;
 
  size_t capacity;
 
  HashTableEntry **buckets;
 
  HashTableHashFunc hash;
 
  HashTableEqualFunc equal;
 
  Consumer destroyKey;
 
  Consumer destroyValue;
};
 
struct HashTableInterface {
 
  ObjectInterface objectInterface;
 
  bool (*containsKey)(const HashTable *self, const ident key);
 
  void (*enumerate)(const HashTable *self, HashTableEnumerator enumerator, ident data);
 
  ident (*get)(const HashTable *self, const ident key);
 
  HashTable *(*init)(HashTable *self, HashTableHashFunc hash, HashTableEqualFunc equal);
 
  HashTable *(*initWithCapacity)(HashTable *self, HashTableHashFunc hash, HashTableEqualFunc equal, size_t capacity);
 
  void (*remove)(HashTable *self, const ident key);
 
  void (*removeAll)(HashTable *self);
 
  void (*set)(HashTable *self, const ident key, const ident value);
};
 
OBJECTIVELY_EXPORT Class *_HashTable(void);