glib-2.0/glib/gsequence.h

0001 /* GLIB - Library of useful routines for C programming
0002  * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007
0003  * Soeren Sandmann (sandmann@daimi.au.dk)
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General Public
0018  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  */
0020
0021 #ifndef __G_SEQUENCE_H__
0022 #define __G_SEQUENCE_H__
0023
0024 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
0025 #error "Only <glib.h> can be included directly."
0026 #endif
0027
0028 #include <glib/gtypes.h>
0029
0030 G_BEGIN_DECLS
0031
0032 typedef struct _GSequence      GSequence;
0033 typedef struct _GSequenceNode  GSequenceIter;
0034
0035 typedef gint (* GSequenceIterCompareFunc) (GSequenceIter *a,
0036                                            GSequenceIter *b,
0037                                            gpointer       data);
0038
0039
0040 /* GSequence */
0041 GLIB_AVAILABLE_IN_ALL
0042 GSequence *    g_sequence_new                (GDestroyNotify            data_destroy);
0043 GLIB_AVAILABLE_IN_ALL
0044 void           g_sequence_free               (GSequence                *seq);
0045 GLIB_AVAILABLE_IN_ALL
0046 gint           g_sequence_get_length         (GSequence                *seq);
0047 GLIB_AVAILABLE_IN_ALL
0048 void           g_sequence_foreach            (GSequence                *seq,
0049                                               GFunc                     func,
0050                                               gpointer                  user_data);
0051 GLIB_AVAILABLE_IN_ALL
0052 void           g_sequence_foreach_range      (GSequenceIter            *begin,
0053                                               GSequenceIter            *end,
0054                                               GFunc                     func,
0055                                               gpointer                  user_data);
0056 GLIB_AVAILABLE_IN_ALL
0057 void           g_sequence_sort               (GSequence                *seq,
0058                                               GCompareDataFunc          cmp_func,
0059                                               gpointer                  cmp_data);
0060 GLIB_AVAILABLE_IN_ALL
0061 void           g_sequence_sort_iter          (GSequence                *seq,
0062                                               GSequenceIterCompareFunc  cmp_func,
0063                                               gpointer                  cmp_data);
0064 GLIB_AVAILABLE_IN_2_48
0065 gboolean       g_sequence_is_empty           (GSequence                *seq);
0066
0067
0068 /* Getting iters */
0069 GLIB_AVAILABLE_IN_ALL
0070 GSequenceIter *g_sequence_get_begin_iter     (GSequence                *seq);
0071 GLIB_AVAILABLE_IN_ALL
0072 GSequenceIter *g_sequence_get_end_iter       (GSequence                *seq);
0073 GLIB_AVAILABLE_IN_ALL
0074 GSequenceIter *g_sequence_get_iter_at_pos    (GSequence                *seq,
0075                                               gint                      pos);
0076 GLIB_AVAILABLE_IN_ALL
0077 GSequenceIter *g_sequence_append             (GSequence                *seq,
0078                                               gpointer                  data);
0079 GLIB_AVAILABLE_IN_ALL
0080 GSequenceIter *g_sequence_prepend            (GSequence                *seq,
0081                                               gpointer                  data);
0082 GLIB_AVAILABLE_IN_ALL
0083 GSequenceIter *g_sequence_insert_before      (GSequenceIter            *iter,
0084                                               gpointer                  data);
0085 GLIB_AVAILABLE_IN_ALL
0086 void           g_sequence_move               (GSequenceIter            *src,
0087                                               GSequenceIter            *dest);
0088 GLIB_AVAILABLE_IN_ALL
0089 void           g_sequence_swap               (GSequenceIter            *a,
0090                                               GSequenceIter            *b);
0091 GLIB_AVAILABLE_IN_ALL
0092 GSequenceIter *g_sequence_insert_sorted      (GSequence                *seq,
0093                                               gpointer                  data,
0094                                               GCompareDataFunc          cmp_func,
0095                                               gpointer                  cmp_data);
0096 GLIB_AVAILABLE_IN_ALL
0097 GSequenceIter *g_sequence_insert_sorted_iter (GSequence                *seq,
0098                                               gpointer                  data,
0099                                               GSequenceIterCompareFunc  iter_cmp,
0100                                               gpointer                  cmp_data);
0101 GLIB_AVAILABLE_IN_ALL
0102 void           g_sequence_sort_changed       (GSequenceIter            *iter,
0103                                               GCompareDataFunc          cmp_func,
0104                                               gpointer                  cmp_data);
0105 GLIB_AVAILABLE_IN_ALL
0106 void           g_sequence_sort_changed_iter  (GSequenceIter            *iter,
0107                                               GSequenceIterCompareFunc  iter_cmp,
0108                                               gpointer                  cmp_data);
0109 GLIB_AVAILABLE_IN_ALL
0110 void           g_sequence_remove             (GSequenceIter            *iter);
0111 GLIB_AVAILABLE_IN_ALL
0112 void           g_sequence_remove_range       (GSequenceIter            *begin,
0113                                               GSequenceIter            *end);
0114 GLIB_AVAILABLE_IN_ALL
0115 void           g_sequence_move_range         (GSequenceIter            *dest,
0116                                               GSequenceIter            *begin,
0117                                               GSequenceIter            *end);
0118 GLIB_AVAILABLE_IN_ALL
0119 GSequenceIter *g_sequence_search             (GSequence                *seq,
0120                                               gpointer                  data,
0121                                               GCompareDataFunc          cmp_func,
0122                                               gpointer                  cmp_data);
0123 GLIB_AVAILABLE_IN_ALL
0124 GSequenceIter *g_sequence_search_iter        (GSequence                *seq,
0125                                               gpointer                  data,
0126                                               GSequenceIterCompareFunc  iter_cmp,
0127                                               gpointer                  cmp_data);
0128 GLIB_AVAILABLE_IN_ALL
0129 GSequenceIter *g_sequence_lookup             (GSequence                *seq,
0130                                               gpointer                  data,
0131                                               GCompareDataFunc          cmp_func,
0132                                               gpointer                  cmp_data);
0133 GLIB_AVAILABLE_IN_ALL
0134 GSequenceIter *g_sequence_lookup_iter        (GSequence                *seq,
0135                                               gpointer                  data,
0136                                               GSequenceIterCompareFunc  iter_cmp,
0137                                               gpointer                  cmp_data);
0138
0139
0140 /* Dereferencing */
0141 GLIB_AVAILABLE_IN_ALL
0142 gpointer       g_sequence_get                (GSequenceIter            *iter);
0143 GLIB_AVAILABLE_IN_ALL
0144 void           g_sequence_set                (GSequenceIter            *iter,
0145                                               gpointer                  data);
0146
0147 /* Operations on GSequenceIter * */
0148 GLIB_AVAILABLE_IN_ALL
0149 gboolean       g_sequence_iter_is_begin      (GSequenceIter            *iter);
0150 GLIB_AVAILABLE_IN_ALL
0151 gboolean       g_sequence_iter_is_end        (GSequenceIter            *iter);
0152 GLIB_AVAILABLE_IN_ALL
0153 GSequenceIter *g_sequence_iter_next          (GSequenceIter            *iter);
0154 GLIB_AVAILABLE_IN_ALL
0155 GSequenceIter *g_sequence_iter_prev          (GSequenceIter            *iter);
0156 GLIB_AVAILABLE_IN_ALL
0157 gint           g_sequence_iter_get_position  (GSequenceIter            *iter);
0158 GLIB_AVAILABLE_IN_ALL
0159 GSequenceIter *g_sequence_iter_move          (GSequenceIter            *iter,
0160                                               gint                      delta);
0161 GLIB_AVAILABLE_IN_ALL
0162 GSequence *    g_sequence_iter_get_sequence  (GSequenceIter            *iter);
0163
0164
0165 /* Search */
0166 GLIB_AVAILABLE_IN_ALL
0167 gint           g_sequence_iter_compare       (GSequenceIter            *a,
0168                                               GSequenceIter            *b);
0169 GLIB_AVAILABLE_IN_ALL
0170 GSequenceIter *g_sequence_range_get_midpoint (GSequenceIter            *begin,
0171                                               GSequenceIter            *end);
0172
0173 G_END_DECLS
0174
0175 #endif /* __G_SEQUENCE_H__ */