libltdl/libltdl/slist.h
094104a7
 /* slist.h -- generalised singly linked lists
 
8c2fae4a
    Copyright (C) 2000, 2004, 2009, 2011-2015 Free Software Foundation,
    Inc.
094104a7
    Written by Gary V. Vaughan, 2000
 
    NOTE: The canonical source of this file is maintained with the
    GNU Libtool package.  Report bugs to bug-libtool@gnu.org.
 
 GNU Libltdl is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2 of the License, or (at your option) any later version.
 
 As a special exception to the GNU Lesser General Public License,
 if you distribute this file as part of a program or library that
 is built using GNU Libtool, you may include this file under the
 same distribution terms that you use for the rest of that program.
 
 GNU Libltdl 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 Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public
 License along with GNU Libltdl; see the file COPYING.LIB.  If not, a
 copy can be downloaded from  http://www.gnu.org/licenses/lgpl.html,
 or obtained by writing to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
 /* A generalised list.  This is deliberately transparent so that you
    can make the NEXT field of all your chained data structures first,
8c2fae4a
    and then cast them to '(SList *)' so that they can be manipulated
094104a7
    by this API.
 
    Alternatively, you can generate raw SList elements using slist_new(),
    and put the element data in the USERDATA field.  Either way you
    get to manage the memory involved by yourself.
 */
 
8c2fae4a
 #if !defined SLIST_H
094104a7
 #define SLIST_H 1
 
8c2fae4a
 #if defined LTDL
094104a7
 #  include <libltdl/lt__glibc.h>
 #  include <libltdl/lt_system.h>
 #else
 #  define LT_SCOPE
 #endif
 
4fe129a3
 #include <stddef.h>
 
8c2fae4a
 #if defined __cplusplus
094104a7
 extern "C" {
 #endif
 
 typedef struct slist {
   struct slist *next;		/* chain forward pointer*/
8c2fae4a
   const void *userdata;		/* for boxed 'SList' item */
094104a7
 } SList;
 
 typedef void *	SListCallback	(SList *item, void *userdata);
 typedef int	SListCompare	(const SList *item1, const SList *item2,
 				 void *userdata);
 
 LT_SCOPE SList *slist_concat	(SList *head, SList *tail);
 LT_SCOPE SList *slist_cons	(SList *item, SList *slist);
 
 LT_SCOPE SList *slist_delete	(SList *slist, void (*delete_fct) (void *item));
4fe129a3
 LT_SCOPE SList *slist_remove	(SList **phead, SListCallback *find,
094104a7
 				 void *matchdata);
 LT_SCOPE SList *slist_reverse	(SList *slist);
 LT_SCOPE SList *slist_sort	(SList *slist, SListCompare *compare,
 				 void *userdata);
 
 LT_SCOPE SList *slist_tail	(SList *slist);
 LT_SCOPE SList *slist_nth	(SList *slist, size_t n);
 LT_SCOPE void *	slist_find	(SList *slist, SListCallback *find,
 				 void *matchdata);
 LT_SCOPE size_t slist_length	(SList *slist);
 
 LT_SCOPE void *	slist_foreach   (SList *slist, SListCallback *foreach,
 				 void *userdata);
 
 LT_SCOPE SList *slist_box	(const void *userdata);
 LT_SCOPE void *	slist_unbox	(SList *item);
 
8c2fae4a
 #if defined __cplusplus
094104a7
 }
 #endif
 
8c2fae4a
 #if !defined LTDL
094104a7
 #  undef LT_SCOPE
 #endif
 
8c2fae4a
 #endif /*!defined SLIST_H*/