annotate lib/gl_xmap.h @ 40057:b06060465f09

maint: Run 'make update-copyright'
author Paul Eggert <eggert@cs.ucla.edu>
date Tue, 01 Jan 2019 00:25:11 +0100
parents 6e03d13e4ae0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
40021
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Abstract map data type, with out-of-memory checking.
40057
b06060465f09 maint: Run 'make update-copyright'
Paul Eggert <eggert@cs.ucla.edu>
parents: 40021
diff changeset
2 Copyright (C) 2009-2019 Free Software Foundation, Inc.
40021
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Written by Bruno Haible <bruno@clisp.org>, 2018.
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 This program is free software: you can redistribute it and/or modify
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
8 (at your option) any later version.
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 #ifndef _GL_XMAP_H
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #define _GL_XMAP_H
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 #include "gl_map.h"
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 #include "xalloc.h"
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 #ifndef _GL_INLINE_HEADER_BEGIN
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 #error "Please include config.h first."
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #endif
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 _GL_INLINE_HEADER_BEGIN
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 #ifndef GL_XMAP_INLINE
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 # define GL_XMAP_INLINE _GL_INLINE
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 #endif
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 #ifdef __cplusplus
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 extern "C" {
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 #endif
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 /* These functions are thin wrappers around the corresponding functions with
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 _nx_ infix from gl_map.h. Upon out-of-memory, they invoke xalloc_die (),
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 instead of returning an error indicator. */
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 #if 0 /* These are defined inline below. */
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 extern gl_map_t gl_map_create_empty (gl_map_implementation_t implementation,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 gl_mapkey_equals_fn equals_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 gl_mapkey_hashcode_fn hashcode_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 gl_mapkey_dispose_fn kdispose_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 gl_mapvalue_dispose_fn vdispose_fn);
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 extern bool gl_map_put (gl_map_t map, const void *key, const void *value);
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 extern bool gl_map_getput (gl_map_t map, const void *key, const void *value,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 const void **oldvaluep);
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49 #endif
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 GL_XMAP_INLINE gl_map_t
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 gl_map_create_empty (gl_map_implementation_t implementation,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 gl_mapkey_equals_fn equals_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
54 gl_mapkey_hashcode_fn hashcode_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 gl_mapkey_dispose_fn kdispose_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 gl_mapvalue_dispose_fn vdispose_fn)
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 {
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58 gl_map_t result =
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59 gl_map_nx_create_empty (implementation, equals_fn, hashcode_fn,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 kdispose_fn, vdispose_fn);
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61 if (result == NULL)
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 xalloc_die ();
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 return result;
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 }
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66 GL_XMAP_INLINE bool
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67 gl_map_put (gl_map_t map, const void *key, const void *value)
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 {
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69 int result = gl_map_nx_put (map, key, value);
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 if (result < 0)
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 xalloc_die ();
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72 return result;
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 }
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 GL_XMAP_INLINE bool
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 gl_map_getput (gl_map_t map, const void *key, const void *value,
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 const void **oldvaluep)
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78 {
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 int result = gl_map_nx_getput (map, key, value, oldvaluep);
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80 if (result < 0)
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
81 xalloc_die ();
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
82 return result;
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83 }
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
84
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
85 #ifdef __cplusplus
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
86 }
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
87 #endif
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
88
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
89 _GL_INLINE_HEADER_END
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
90
6e03d13e4ae0 xmap: New module.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
91 #endif /* _GL_XMAP_H */