lib/gl_sublist.h

   1 /* Sequential list data type backed by another list.
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2006.
   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 2, or (at your option)
   8    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, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #ifndef _GL_SUBLIST_H
  20 #define _GL_SUBLIST_H
  21
  22 #include "gl_list.h"
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28
  29 /* Create a sublist of a given list.
  30    This is the list of elements with indices i, start_index <= i < end_index.
  31    The sublist is backed by the given list, which means:
  32      - Modifications to the sublist affect the whole list.
  33      - Modifications to the whole list are immediately visible in the sublist.
  34      - The sublist is only valid as long as the whole list is valid.
  35      - The sublist must not be passed to the gl_list_sortedlist_add() function.
  36  */
  37 extern gl_list_t gl_sublist_create (gl_list_t whole_list,
  38                                     size_t start_index, size_t end_index);
  39
  40
  41 #ifdef __cplusplus
  42 }
  43 #endif
  44
  45 #endif /* _GL_SUBLIST_H */