lib/gl_xsublist.h

   1 /* Sequential list data type backed by another list, with out-of-memory
   2    checking.
   3    Copyright (C) 2009-2025 Free Software Foundation, Inc.
   4    Written by Bruno Haible <bruno@clisp.org>, 2009.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _GL_XSUBLIST_H
  20 #define _GL_XSUBLIST_H
  21
  22 /* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE,
  23    _GL_ATTRIBUTE_RETURNS_NONNULL.  */
  24 #if !_GL_CONFIG_H_INCLUDED
  25  #error "Please include config.h first."
  26 #endif
  27
  28 #include "gl_sublist.h"
  29 #include "xalloc.h"
  30
  31 _GL_INLINE_HEADER_BEGIN
  32 #ifndef GL_XSUBLIST_INLINE
  33 # define GL_XSUBLIST_INLINE _GL_INLINE
  34 #endif
  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_sublist.h.  Upon out-of-memory, they invoke
  42    xalloc_die (), instead of returning an error indicator.  */
  43 GL_XSUBLIST_INLINE
  44 /*_GL_ATTRIBUTE_DEALLOC (gl_list_free, 1)*/
  45 _GL_ATTRIBUTE_RETURNS_NONNULL
  46 gl_list_t
  47 gl_sublist_create (gl_list_t whole_list, size_t start_index, size_t end_index)
  48 {
  49   gl_list_t result = gl_sublist_nx_create (whole_list, start_index, end_index);
  50   if (result == NULL)
  51     xalloc_die ();
  52   return result;
  53 }
  54
  55 #ifdef __cplusplus
  56 }
  57 #endif
  58
  59 _GL_INLINE_HEADER_END
  60
  61 #endif /* _GL_XSUBLIST_H */