utils/public/include/hash_map.h

/**
 *Licensed to the Apache Software Foundation (ASF) under one
 *or more contributor license agreements.  See the NOTICE file
 *distributed with this work for additional information
 *regarding copyright ownership.  The ASF licenses this file
 *to you under the Apache License, Version 2.0 (the
 *"License"); you may not use this file except in compliance
 *with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *Unless required by applicable law or agreed to in writing,
 *software distributed under the License is distributed on an
 *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 *specific language governing permissions and limitations
 *under the License.
 */
/*
 * hash_map.h
 *
 *  \date       Jul 21, 2010
 *  \author    	<a href="mailto:dev@celix.apache.org">Apache Celix Project Team</a>
 *  \copyright	Apache License, Version 2.0
 */

#ifndef HASH_MAP_H_
#define HASH_MAP_H_

#include "celixbool.h"
#include "exports.h"

typedef struct hashMapEntry * hash_map_entry_pt;
typedef struct hashMap * hash_map_pt;

struct hashMapIterator {
    hash_map_pt map;
    hash_map_entry_pt next;
    hash_map_entry_pt current;
    int expectedModCount;
    int index;
};

typedef struct hashMapIterator hash_map_iterator_t;
typedef hash_map_iterator_t * hash_map_iterator_pt;

typedef struct hashMapKeySet * hash_map_key_set_pt;
typedef struct hashMapValues * hash_map_values_pt;
typedef struct hashMapEntrySet * hash_map_entry_set_pt;

UTILS_EXPORT hash_map_pt hashMap_create(unsigned int (*keyHash)(const void*), unsigned int (*valueHash)(const void*),
		int (*keyEquals)(const void*, const void*), int (*valueEquals)(const void*, const void*));
UTILS_EXPORT void hashMap_destroy(hash_map_pt map, bool freeKeys, bool freeValues);
UTILS_EXPORT int hashMap_size(hash_map_pt map);
UTILS_EXPORT bool hashMap_isEmpty(hash_map_pt map);
UTILS_EXPORT void * hashMap_get(hash_map_pt map, const void* key);
UTILS_EXPORT bool hashMap_containsKey(hash_map_pt map, const void* key);
UTILS_EXPORT hash_map_entry_pt hashMap_getEntry(hash_map_pt map, const void* key);
UTILS_EXPORT void * hashMap_put(hash_map_pt map, void* key, void* value);
UTILS_EXPORT void * hashMap_remove(hash_map_pt map, const void* key);
UTILS_EXPORT void hashMap_clear(hash_map_pt map, bool freeKey, bool freeValue);
UTILS_EXPORT bool hashMap_containsValue(hash_map_pt map, const void* value);

UTILS_EXPORT hash_map_iterator_pt hashMapIterator_create(hash_map_pt map);
UTILS_EXPORT void hashMapIterator_destroy(hash_map_iterator_pt iterator);
UTILS_EXPORT hash_map_iterator_pt hashMapIterator_alloc(void);
UTILS_EXPORT void hashMapIterator_dealloc(hash_map_iterator_pt iterator);
UTILS_EXPORT void hashMapIterator_init(hash_map_pt map, hash_map_iterator_pt iterator);
UTILS_EXPORT void hashMapIterator_deinit(hash_map_iterator_pt iterator);
UTILS_EXPORT hash_map_iterator_t hashMapIterator_construct(hash_map_pt map);


UTILS_EXPORT bool hashMapIterator_hasNext(hash_map_iterator_pt iterator);
UTILS_EXPORT void hashMapIterator_remove(hash_map_iterator_pt iterator);
UTILS_EXPORT void * hashMapIterator_nextValue(hash_map_iterator_pt iterator);
UTILS_EXPORT void * hashMapIterator_nextKey(hash_map_iterator_pt iterator);
UTILS_EXPORT hash_map_entry_pt hashMapIterator_nextEntry(hash_map_iterator_pt iterator);

UTILS_EXPORT hash_map_key_set_pt hashMapKeySet_create(hash_map_pt map);
UTILS_EXPORT void hashMapKeySet_destroy(hash_map_key_set_pt keySet);
UTILS_EXPORT int hashMapKeySet_size(hash_map_key_set_pt keySet);
UTILS_EXPORT bool hashMapKeySet_contains(hash_map_key_set_pt keySet, const void* key);
UTILS_EXPORT bool hashMapKeySet_remove(hash_map_key_set_pt keySet, const void* key);
UTILS_EXPORT void hashMapKeySet_clear(hash_map_key_set_pt keySet);
UTILS_EXPORT bool hashMapKeySet_isEmpty(hash_map_key_set_pt keySet);

UTILS_EXPORT hash_map_values_pt hashMapValues_create(hash_map_pt map);
UTILS_EXPORT void hashMapValues_destroy(hash_map_values_pt values);
UTILS_EXPORT hash_map_iterator_pt hashMapValues_iterator(hash_map_values_pt values);
UTILS_EXPORT int hashMapValues_size(hash_map_values_pt values);
UTILS_EXPORT bool hashMapValues_contains(hash_map_values_pt values, const void* o);
UTILS_EXPORT void hashMapValues_toArray(hash_map_values_pt values, void* *array[], unsigned int *size);
UTILS_EXPORT bool hashMapValues_remove(hash_map_values_pt values, const void* o);
UTILS_EXPORT void hashMapValues_clear(hash_map_values_pt values);
UTILS_EXPORT bool hashMapValues_isEmpty(hash_map_values_pt values);

UTILS_EXPORT hash_map_entry_set_pt hashMapEntrySet_create(hash_map_pt map);
UTILS_EXPORT void hashMapEntrySet_destroy(hash_map_entry_set_pt entrySet);
UTILS_EXPORT int hashMapEntrySet_size(hash_map_entry_set_pt entrySet);
UTILS_EXPORT bool hashMapEntrySet_contains(hash_map_entry_set_pt entrySet, hash_map_entry_pt entry);
UTILS_EXPORT bool hashMapEntrySet_remove(hash_map_entry_set_pt entrySet, hash_map_entry_pt entry);
UTILS_EXPORT void hashMapEntrySet_clear(hash_map_entry_set_pt entrySet);
UTILS_EXPORT bool hashMapEntrySet_isEmpty(hash_map_entry_set_pt entrySet);

UTILS_EXPORT void * hashMapEntry_getKey(hash_map_entry_pt entry);
UTILS_EXPORT void * hashMapEntry_getValue(hash_map_entry_pt entry);

#endif /* HASH_MAP_H_ */