Move the malloc checking from module 'oset' to new module 'xoset'.
[gnulib.git] / lib / gl_xoset.h
diff --git a/lib/gl_xoset.h b/lib/gl_xoset.h
new file mode 100644 (file)
index 0000000..d9701b7
--- /dev/null
@@ -0,0 +1,67 @@
+/* Abstract ordered set data type, with out-of-memory checking.
+   Copyright (C) 2009 Free Software Foundation, Inc.
+   Written by Bruno Haible <bruno@clisp.org>, 2009.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
+
+   This program 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 General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+#ifndef _GL_XOSET_H
+#define _GL_XOSET_H
+
+#include "gl_oset.h"
+#include "xalloc.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* These functions are thin wrappers around the corresponding functions with
+   _nx_ infix from gl_oset.h.  Upon out-of-memory, they invoke xalloc_die (),
+   instead of returning an error indicator.  */
+extern gl_oset_t gl_oset_create_empty (gl_oset_implementation_t implementation,
+                                       gl_setelement_compar_fn compar_fn,
+                                       gl_setelement_dispose_fn dispose_fn);
+extern bool gl_oset_add (gl_oset_t set, const void *elt);
+
+#if HAVE_INLINE
+
+# define gl_oset_create_empty gl_oset_create_empty_inline
+static inline gl_oset_t
+gl_oset_create_empty (gl_oset_implementation_t implementation,
+                      gl_setelement_compar_fn compar_fn,
+                      gl_setelement_dispose_fn dispose_fn)
+{
+  gl_oset_t result =
+    gl_oset_nx_create_empty (implementation, compar_fn, dispose_fn);
+  if (result == NULL)
+    xalloc_die ();
+  return result;
+}
+
+# define gl_oset_add gl_oset_add_inline
+static inline bool
+gl_oset_add (gl_oset_t set, const void *elt)
+{
+  int result = gl_oset_nx_add (set, elt);
+  if (result < 0)
+    xalloc_die ();
+  return result;
+}
+
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _GL_XOSET_H */