Home | History | Annotate | Download | only in util
      1 /**************************************************************************
      2  *
      3  * Copyright 2008 VMware, Inc.
      4  * All Rights Reserved.
      5  *
      6  * Permission is hereby granted, free of charge, to any person obtaining a
      7  * copy of this software and associated documentation files (the
      8  * "Software"), to deal in the Software without restriction, including
      9  * without limitation the rights to use, copy, modify, merge, publish,
     10  * distribute, sub license, and/or sell copies of the Software, and to
     11  * permit persons to whom the Software is furnished to do so, subject to
     12  * the following conditions:
     13  *
     14  * The above copyright notice and this permission notice (including the
     15  * next paragraph) shall be included in all copies or substantial portions
     16  * of the Software.
     17  *
     18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
     19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
     21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
     22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
     23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
     24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     25  *
     26  **************************************************************************/
     27 
     28 #ifndef U_KEYMAP_H
     29 #define U_KEYMAP_H
     30 
     31 #include "pipe/p_compiler.h"
     32 
     33 
     34 /** opaque keymap type */
     35 struct keymap;
     36 
     37 
     38 /** Delete/callback function type */
     39 typedef void (*keymap_delete_func)(const struct keymap *map,
     40                                    const void *key, void *data,
     41                                    void *user);
     42 
     43 
     44 extern struct keymap *
     45 util_new_keymap(unsigned keySize, unsigned maxEntries,
     46                 keymap_delete_func deleteFunc);
     47 
     48 extern void
     49 util_delete_keymap(struct keymap *map, void *user);
     50 
     51 extern boolean
     52 util_keymap_insert(struct keymap *map, const void *key,
     53                    const void *data, void *user);
     54 
     55 extern const void *
     56 util_keymap_lookup(const struct keymap *map, const void *key);
     57 
     58 extern void
     59 util_keymap_remove(struct keymap *map, const void *key, void *user);
     60 
     61 extern void
     62 util_keymap_remove_all(struct keymap *map, void *user);
     63 
     64 extern void
     65 util_keymap_info(const struct keymap *map);
     66 
     67 
     68 #endif /* U_KEYMAP_H */
     69