verify: new macro 'assume'
[gnulib.git] / lib / gl_xoset.h
1 /* Abstract ordered set data type, with out-of-memory checking.
2    Copyright (C) 2009-2013 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 <http://www.gnu.org/licenses/>.  */
17
18 #ifndef _GL_XOSET_H
19 #define _GL_XOSET_H
20
21 #include "gl_oset.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_XOSET_INLINE
29 # define GL_XOSET_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_oset.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_oset_t gl_oset_create_empty (gl_oset_implementation_t implementation,
42                                        gl_setelement_compar_fn compar_fn,
43                                        gl_setelement_dispose_fn dispose_fn);
44 extern bool gl_oset_add (gl_oset_t set, const void *elt);
45 #endif
46
47 GL_XOSET_INLINE gl_oset_t
48 gl_oset_create_empty (gl_oset_implementation_t implementation,
49                       gl_setelement_compar_fn compar_fn,
50                       gl_setelement_dispose_fn dispose_fn)
51 {
52   gl_oset_t result =
53     gl_oset_nx_create_empty (implementation, compar_fn, dispose_fn);
54   if (result == NULL)
55     xalloc_die ();
56   return result;
57 }
58
59 GL_XOSET_INLINE bool
60 gl_oset_add (gl_oset_t set, const void *elt)
61 {
62   int result = gl_oset_nx_add (set, elt);
63   if (result < 0)
64     xalloc_die ();
65   return result;
66 }
67
68 #ifdef __cplusplus
69 }
70 #endif
71
72 _GL_INLINE_HEADER_END
73
74 #endif /* _GL_XOSET_H */