1 /* Abstract set data type, with out-of-memory checking.
2 Copyright (C) 2009-2021 Free Software Foundation, Inc.
3 Written by Bruno Haible <bruno@clisp.org>, 2009.
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17
18 #ifndef _GL_XSET_H
19 #define _GL_XSET_H
20
21 #include "gl_set.h"
22 #include "xalloc.h"
23
24 #ifndef _GL_INLINE_HEADER_BEGIN
25 #error "Please include config.h first."
26 #endif
27 _GL_INLINE_HEADER_BEGIN
28 #ifndef GL_XSET_INLINE
29 # define GL_XSET_INLINE _GL_INLINE
30 #endif
31
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /* These functions are thin wrappers around the corresponding functions with
38 _nx_ infix from gl_set.h. Upon out-of-memory, they invoke xalloc_die (),
39 instead of returning an error indicator. */
40 #if 0 /* These are defined inline below. */
41 extern gl_set_t gl_set_create_empty (gl_set_implementation_t implementation,
/* ![[previous]](../icons/n_left.png)
![[next]](../icons/right.png)
![[first]](../icons/n_first.png)
![[last]](../icons/last.png)
![[top]](../icons/top.png)
![[bottom]](../icons/bottom.png)
![[index]](../icons/index.png)
*/
42 gl_setelement_equals_fn equals_fn,
43 gl_setelement_hashcode_fn hashcode_fn,
44 gl_setelement_dispose_fn dispose_fn)
45 /*_GL_ATTRIBUTE_DEALLOC (gl_set_free, 1)*/
46 _GL_ATTRIBUTE_RETURNS_NONNULL;
47 extern bool gl_set_add (gl_set_t set, const void *elt);
48 #endif
49
50 GL_XSET_INLINE
51 /*_GL_ATTRIBUTE_DEALLOC (gl_set_free, 1)*/
52 _GL_ATTRIBUTE_RETURNS_NONNULL
53 gl_set_t
54 gl_set_create_empty (gl_set_implementation_t implementation,
55 gl_setelement_equals_fn equals_fn,
56 gl_setelement_hashcode_fn hashcode_fn,
57 gl_setelement_dispose_fn dispose_fn)
58 {
59 gl_set_t result =
60 gl_set_nx_create_empty (implementation, equals_fn, hashcode_fn, dispose_fn);
61 if (result == NULL)
62 xalloc_die ();
63 return result;
64 }
65
66 GL_XSET_INLINE bool
67 gl_set_add (gl_set_t set, const void *elt)
/* ![[previous]](../icons/left.png)
![[next]](../icons/n_right.png)
![[first]](../icons/first.png)
![[last]](../icons/n_last.png)
![[top]](../icons/top.png)
![[bottom]](../icons/bottom.png)
![[index]](../icons/index.png)
*/
68 {
69 int result = gl_set_nx_add (set, elt);
70 if (result < 0)
71 xalloc_die ();
72 return result;
73 }
74
75 #ifdef __cplusplus
76 }
77 #endif
78
79 _GL_INLINE_HEADER_END
80
81 #endif /* _GL_XSET_H */