glib/gslist.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_SLIST_H__
  28 #define __G_SLIST_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gmem.h>
  35 #include <glib/gnode.h>
  36
  37 G_BEGIN_DECLS
  38
  39 typedef struct _GSList GSList;
  40
  41 struct _GSList
  42 {
  43   gpointer data;
  44   GSList *next;
  45 };
  46
  47 /* Singly linked lists
  48  */
  49 GSList*  g_slist_alloc                   (void) G_GNUC_WARN_UNUSED_RESULT;
  50 void     g_slist_free                    (GSList           *list);
  51 void     g_slist_free_1                  (GSList           *list);
  52 #define  g_slist_free1                   g_slist_free_1
  53 void     g_slist_free_full               (GSList           *list,
  54                                           GDestroyNotify    free_func);
  55 GSList*  g_slist_append                  (GSList           *list,
  56                                           gpointer          data) G_GNUC_WARN_UNUSED_RESULT;
  57 GSList*  g_slist_prepend                 (GSList           *list,
  58                                           gpointer          data) G_GNUC_WARN_UNUSED_RESULT;
  59 GSList*  g_slist_insert                  (GSList           *list,
  60                                           gpointer          data,
  61                                           gint              position) G_GNUC_WARN_UNUSED_RESULT;
  62 GSList*  g_slist_insert_sorted           (GSList           *list,
  63                                           gpointer          data,
  64                                           GCompareFunc      func) G_GNUC_WARN_UNUSED_RESULT;
  65 GSList*  g_slist_insert_sorted_with_data (GSList           *list,
  66                                           gpointer          data,
  67                                           GCompareDataFunc  func,
  68                                           gpointer          user_data) G_GNUC_WARN_UNUSED_RESULT;
  69 GSList*  g_slist_insert_before           (GSList           *slist,
  70                                           GSList           *sibling,
  71                                           gpointer          data) G_GNUC_WARN_UNUSED_RESULT;
  72 GSList*  g_slist_concat                  (GSList           *list1,
  73                                           GSList           *list2) G_GNUC_WARN_UNUSED_RESULT;
  74 GSList*  g_slist_remove                  (GSList           *list,
  75                                           gconstpointer     data) G_GNUC_WARN_UNUSED_RESULT;
  76 GSList*  g_slist_remove_all              (GSList           *list,
  77                                           gconstpointer     data) G_GNUC_WARN_UNUSED_RESULT;
  78 GSList*  g_slist_remove_link             (GSList           *list,
  79                                           GSList           *link_) G_GNUC_WARN_UNUSED_RESULT;
  80 GSList*  g_slist_delete_link             (GSList           *list,
  81                                           GSList           *link_) G_GNUC_WARN_UNUSED_RESULT;
  82 GSList*  g_slist_reverse                 (GSList           *list) G_GNUC_WARN_UNUSED_RESULT;
  83 GSList*  g_slist_copy                    (GSList           *list) G_GNUC_WARN_UNUSED_RESULT;
  84
  85 GLIB_AVAILABLE_IN_2_34
  86 GSList*  g_slist_copy_deep               (GSList            *list,
  87                                           GCopyFunc         func,
  88                                           gpointer          user_data) G_GNUC_WARN_UNUSED_RESULT;
  89 GSList*  g_slist_nth                     (GSList           *list,
  90                                           guint             n);
  91 GSList*  g_slist_find                    (GSList           *list,
  92                                           gconstpointer     data);
  93 GSList*  g_slist_find_custom             (GSList           *list,
  94                                           gconstpointer     data,
  95                                           GCompareFunc      func);
  96 gint     g_slist_position                (GSList           *list,
  97                                           GSList           *llink);
  98 gint     g_slist_index                   (GSList           *list,
  99                                           gconstpointer     data);
 100 GSList*  g_slist_last                    (GSList           *list);
 101 guint    g_slist_length                  (GSList           *list);
 102 void     g_slist_foreach                 (GSList           *list,
 103                                           GFunc             func,
 104                                           gpointer          user_data);
 105 GSList*  g_slist_sort                    (GSList           *list,
 106                                           GCompareFunc      compare_func) G_GNUC_WARN_UNUSED_RESULT;
 107 GSList*  g_slist_sort_with_data          (GSList           *list,
 108                                           GCompareDataFunc  compare_func,
 109                                           gpointer          user_data) G_GNUC_WARN_UNUSED_RESULT;
 110 gpointer g_slist_nth_data                (GSList           *list,
 111                                           guint             n);
 112
 113 #define  g_slist_next(slist)             ((slist) ? (((GSList *)(slist))->next) : NULL)
 114
 115 G_END_DECLS
 116
 117 #endif /* __G_SLIST_H__ */