kMap.h

Go to the documentation of this file.

#ifndef K_API_MAP_H
#define K_API_MAP_H

#include <kApi/kApiDef.h>

kBeginHeader()


//typedef kObject kMap;   --forward-declared in kApiDef.x.h


typedef kPointer kMapItem; 

kFx(kStatus) kMap_Construct(kMap* map, kType keyType, kType valueType, kSize initialCapacity, kAlloc allocator);

kFx(kStatus) kMap_Allocate(kMap map, kType keyType, kType valueType, kSize initialCapacity);

kFx(kStatus) kMap_Assign(kMap map, kMap source);

kFx(kStatus) kMap_SetEqualsFx(kMap map, kEqualsFx function); 

kFx(kSize) kMap_SetHashFx(kMap map, kHashFx function); 

kFx(kType) kMap_KeyType(kMap map); 

kFx(kType) kMap_ValueType(kMap map); 

kFx(kSize) kMap_Count(kMap map); 

kFx(kSize) kMap_Capacity(kMap map); 

kFx(kStatus) kMap_Find(kMap map, const void* key, void* value);

kFx(kStatus) kMap_Add(kMap map, const void* key, const void* value); 

kFx(kStatus) kMap_Replace(kMap map, const void* key, const void* value); 

kFx(kStatus) kMap_Remove(kMap map, const void* key, void* oldKey, void* oldValue); 

kFx(kStatus) kMap_Reserve(kMap map, kSize capacity); 

kFx(kStatus) kMap_Clear(kMap map); 

kFx(kStatus) kMap_Purge(kMap map); 

kFx(kMapItem) kMap_First(kMap map); 

kFx(kMapItem) kMap_Next(kMap map, kMapItem item); 

kFx(kStatus) kMap_FindItem(kMap map, const void* key, kMapItem* item); 

kFx(kStatus) kMap_RemoveItem(kMap map, kMapItem item); 

kFx(const void*) kMap_Key(kMap map, kMapItem item); 

kFx(void*) kMap_Value(kMap map, kMapItem item); 

kFx(kStatus) kMap_SetValue(kMap map, kMapItem item, const void* value); 

#define kMap_KeyType_(MAP)                      kxMap_KeyType_(MAP)                 
#define kMap_ValueType_(MAP)                    kxMap_ValueType_(MAP)               
#define kMap_Count_(MAP)                        kxMap_Count_(MAP)                   


#define kMap_KeyAs_(MAP, ITEM, TYPE)            kxMap_KeyAs_(MAP, ITEM, TYPE) 

#define kMap_ValueAs_(MAP, ITEM, TYPE)          kxMap_ValueAs_(MAP, ITEM, TYPE) 

kEndHeader()

#include <kApi/Data/kMap.x.h>

#endif