/*
   (c) Copyright 2001-2010  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#ifndef __DIRECT__MAP_H__
#define __DIRECT__MAP_H__

#include <direct/types.h>


typedef bool                    (*DirectMapCompareFunc) ( DirectMap    *map,
                                                          const void   *key,
                                                          void         *object,
                                                          void         *ctx );

typedef unsigned int            (*DirectMapHashFunc)    ( DirectMap    *map,
                                                          const void   *key,
                                                          void         *ctx );

typedef DirectEnumerationResult (*DirectMapIteratorFunc)( DirectMap    *map,
                                                          void         *object,
                                                          void         *ctx );


DirectResult  direct_map_create ( unsigned int            initial_size,
                                  DirectMapCompareFunc    compare_func,
                                  DirectMapHashFunc       hash_func,
                                  void                   *ctx,
                                  DirectMap             **ret_map );

void          direct_map_destroy( DirectMap              *map );

DirectResult  direct_map_insert ( DirectMap              *map,
                                  const void             *key,
                                  void                   *object );

DirectResult  direct_map_remove ( DirectMap              *map,
                                  const void             *key );

void         *direct_map_lookup ( DirectMap              *map,
                                  const void             *key );

void          direct_map_iterate( DirectMap              *map,
                                  DirectMapIteratorFunc   func,
                                  void                   *ctx );

#endif