lib/gl_xomap.h

   1 /* Abstract ordered map data type, with out-of-memory checking.
   2    Copyright (C) 2009-2024 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2018.
   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_XOMAP_H
  19 #define _GL_XOMAP_H
  20
  21 /* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE,
  22    _GL_ATTRIBUTE_RETURNS_NONNULL.  */
  23 #if !_GL_CONFIG_H_INCLUDED
  24  #error "Please include config.h first."
  25 #endif
  26
  27 #include "gl_omap.h"
  28 #include "xalloc.h"
  29
  30 _GL_INLINE_HEADER_BEGIN
  31 #ifndef GL_XOMAP_INLINE
  32 # define GL_XOMAP_INLINE _GL_INLINE
  33 #endif
  34
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /* These functions are thin wrappers around the corresponding functions with
  41    _nx_ infix from gl_omap.h.  Upon out-of-memory, they invoke xalloc_die (),
  42    instead of returning an error indicator.  */
  43 #if 0 /* These are defined inline below.  */
  44 extern gl_omap_t gl_omap_create_empty (gl_omap_implementation_t implementation,
  45                                        gl_mapkey_compar_fn compar_fn,
  46                                        gl_mapkey_dispose_fn kdispose_fn,
  47                                        gl_mapvalue_dispose_fn vdispose_fn)
  48   /*_GL_ATTRIBUTE_DEALLOC (gl_omap_free, 1)*/
  49   _GL_ATTRIBUTE_RETURNS_NONNULL;
  50 extern bool gl_omap_put (gl_omap_t map, const void *key, const void *value);
  51 extern bool gl_omap_getput (gl_omap_t map, const void *key, const void *value,
  52                             const void **oldvaluep);
  53 #endif
  54
  55 GL_XOMAP_INLINE
  56 /*_GL_ATTRIBUTE_DEALLOC (gl_omap_free, 1)*/
  57 _GL_ATTRIBUTE_RETURNS_NONNULL
  58 gl_omap_t
  59 gl_omap_create_empty (gl_omap_implementation_t implementation,
  60                       gl_mapkey_compar_fn compar_fn,
  61                       gl_mapkey_dispose_fn kdispose_fn,
  62                       gl_mapvalue_dispose_fn vdispose_fn)
  63 {
  64   gl_omap_t result =
  65     gl_omap_nx_create_empty (implementation, compar_fn, kdispose_fn, vdispose_fn);
  66   if (result == NULL)
  67     xalloc_die ();
  68   return result;
  69 }
  70
  71 GL_XOMAP_INLINE bool
  72 gl_omap_put (gl_omap_t map, const void *key, const void *value)
  73 {
  74   int result = gl_omap_nx_put (map, key, value);
  75   if (result < 0)
  76     xalloc_die ();
  77   return result;
  78 }
  79
  80 GL_XOMAP_INLINE bool
  81 gl_omap_getput (gl_omap_t map, const void *key, const void *value,
  82                 const void **oldvaluep)
  83 {
  84   int result = gl_omap_nx_getput (map, key, value, oldvaluep);
  85   if (result < 0)
  86     xalloc_die ();
  87   return result;
  88 }
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 _GL_INLINE_HEADER_END
  95
  96 #endif /* _GL_XOMAP_H */