/simpletypesystem/trunk

#ifndef __H_MAP__

#define __H_MAP__

/**

 * An SMap is a data structure that holds many mappings of objects to objects:

 * say, a string to an other string. This can be likened to the Dict structure

 * in python, but not fully.

 * 

 * An SMap is made up of SMapItems, each MapItem holds two pointers to data.

 * The first pointer is the key, the secold is the value.

 *

 * please note that SMaps can be slow and are unordered.

 */

#include "SimpleTypeSystem.h"

#include "baseobject.h"

#include <stdbool.h>

typedef struct _SMapItem SMapItem;

typedef struct _SMap SMap;

typedef struct _SMapClass SMapClass;

typedef struct _SMapPrivate SMapPrivate;

struct _SMapItem {

  void * key;

  void * value;

};

struct _SMap {

  SBaseObjectInstance parent;

  SMapPrivate * priv;

};

struct _SMapClass {

  SBaseObjectClass parentclass;

  bool (* is_equal)(void *, void *); // method to check if items are equal.

};

SMapItem * s_map_item_new (void * key, void * value);

void s_map_item_free (SMapItem * self);

/**

 * s_map_new creates a new SMap oject, it takes a CompFunc as an argument.

 *

 * The compfunc tells the SMap object if the key already exists when

 * adding key/value pares or when searching after a key when retrieving a value.

 */

SMap * s_map_new ( CompFunc comp_func );

void s_map_free (SMap * self);

void s_map_add (SMap * self ,void * key, void * value);

void * s_map_get (SMap * self, void * key);

#endif