1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
31 #error "Only <glib.h> can be included directly."
34 #include <glib/gtypes.h>
38 typedef struct _GBytes GBytes
;
39 typedef struct _GArray GArray
;
40 typedef struct _GByteArray GByteArray
;
41 typedef struct _GPtrArray GPtrArray
;
61 /* Resizable arrays. remove fills any cleared spot and shortens the
62 * array, while preserving the order. remove_fast will distort the
63 * order by moving the last element to the position of the removed.
66 #define g_array_append_val(a,v) g_array_append_vals (a, &(v), 1)
67 #define g_array_prepend_val(a,v) g_array_prepend_vals (a, &(v), 1)
68 #define g_array_insert_val(a,i,v) g_array_insert_vals (a, i, &(v), 1)
69 #define g_array_index(a,t,i) (((t*) (void *) (a)->data) [(i)])
72 GArray
* g_array_new (gboolean zero_terminated
,
76 GArray
* g_array_sized_new (gboolean zero_terminated
,
81 gchar
* g_array_free (GArray
*array
,
82 gboolean free_segment
);
84 GArray
*g_array_ref (GArray
*array
);
86 void g_array_unref (GArray
*array
);
88 guint
g_array_get_element_size (GArray
*array
);
90 GArray
* g_array_append_vals (GArray
*array
,
94 GArray
* g_array_prepend_vals (GArray
*array
,
98 GArray
* g_array_insert_vals (GArray
*array
,
102 GLIB_AVAILABLE_IN_ALL
103 GArray
* g_array_set_size (GArray
*array
,
105 GLIB_AVAILABLE_IN_ALL
106 GArray
* g_array_remove_index (GArray
*array
,
108 GLIB_AVAILABLE_IN_ALL
109 GArray
* g_array_remove_index_fast (GArray
*array
,
111 GLIB_AVAILABLE_IN_ALL
112 GArray
* g_array_remove_range (GArray
*array
,
115 GLIB_AVAILABLE_IN_ALL
116 void g_array_sort (GArray
*array
,
117 GCompareFunc compare_func
);
118 GLIB_AVAILABLE_IN_ALL
119 void g_array_sort_with_data (GArray
*array
,
120 GCompareDataFunc compare_func
,
122 GLIB_AVAILABLE_IN_ALL
123 void g_array_set_clear_func (GArray
*array
,
124 GDestroyNotify clear_func
);
126 /* Resizable pointer array. This interface is much less complicated
127 * than the above. Add appends a pointer. Remove fills any cleared
128 * spot and shortens the array. remove_fast will again distort order.
130 #define g_ptr_array_index(array,index_) ((array)->pdata)[index_]
131 GLIB_AVAILABLE_IN_ALL
132 GPtrArray
* g_ptr_array_new (void);
133 GLIB_AVAILABLE_IN_ALL
134 GPtrArray
* g_ptr_array_new_with_free_func (GDestroyNotify element_free_func
);
135 GLIB_AVAILABLE_IN_ALL
136 GPtrArray
* g_ptr_array_sized_new (guint reserved_size
);
137 GLIB_AVAILABLE_IN_ALL
138 GPtrArray
* g_ptr_array_new_full (guint reserved_size
,
139 GDestroyNotify element_free_func
);
140 GLIB_AVAILABLE_IN_ALL
141 gpointer
* g_ptr_array_free (GPtrArray
*array
,
143 GLIB_AVAILABLE_IN_ALL
144 GPtrArray
* g_ptr_array_ref (GPtrArray
*array
);
145 GLIB_AVAILABLE_IN_ALL
146 void g_ptr_array_unref (GPtrArray
*array
);
147 GLIB_AVAILABLE_IN_ALL
148 void g_ptr_array_set_free_func (GPtrArray
*array
,
149 GDestroyNotify element_free_func
);
150 GLIB_AVAILABLE_IN_ALL
151 void g_ptr_array_set_size (GPtrArray
*array
,
153 GLIB_AVAILABLE_IN_ALL
154 gpointer
g_ptr_array_remove_index (GPtrArray
*array
,
156 GLIB_AVAILABLE_IN_ALL
157 gpointer
g_ptr_array_remove_index_fast (GPtrArray
*array
,
159 GLIB_AVAILABLE_IN_ALL
160 gboolean
g_ptr_array_remove (GPtrArray
*array
,
162 GLIB_AVAILABLE_IN_ALL
163 gboolean
g_ptr_array_remove_fast (GPtrArray
*array
,
165 GLIB_AVAILABLE_IN_ALL
166 void g_ptr_array_remove_range (GPtrArray
*array
,
169 GLIB_AVAILABLE_IN_ALL
170 void g_ptr_array_add (GPtrArray
*array
,
172 GLIB_AVAILABLE_IN_ALL
173 void g_ptr_array_sort (GPtrArray
*array
,
174 GCompareFunc compare_func
);
175 GLIB_AVAILABLE_IN_ALL
176 void g_ptr_array_sort_with_data (GPtrArray
*array
,
177 GCompareDataFunc compare_func
,
179 GLIB_AVAILABLE_IN_ALL
180 void g_ptr_array_foreach (GPtrArray
*array
,
185 /* Byte arrays, an array of guint8. Implemented as a GArray,
189 GLIB_AVAILABLE_IN_ALL
190 GByteArray
* g_byte_array_new (void);
191 GLIB_AVAILABLE_IN_ALL
192 GByteArray
* g_byte_array_new_take (guint8
*data
,
194 GLIB_AVAILABLE_IN_ALL
195 GByteArray
* g_byte_array_sized_new (guint reserved_size
);
196 GLIB_AVAILABLE_IN_ALL
197 guint8
* g_byte_array_free (GByteArray
*array
,
198 gboolean free_segment
);
199 GLIB_AVAILABLE_IN_ALL
200 GBytes
* g_byte_array_free_to_bytes (GByteArray
*array
);
201 GLIB_AVAILABLE_IN_ALL
202 GByteArray
*g_byte_array_ref (GByteArray
*array
);
203 GLIB_AVAILABLE_IN_ALL
204 void g_byte_array_unref (GByteArray
*array
);
205 GLIB_AVAILABLE_IN_ALL
206 GByteArray
* g_byte_array_append (GByteArray
*array
,
209 GLIB_AVAILABLE_IN_ALL
210 GByteArray
* g_byte_array_prepend (GByteArray
*array
,
213 GLIB_AVAILABLE_IN_ALL
214 GByteArray
* g_byte_array_set_size (GByteArray
*array
,
216 GLIB_AVAILABLE_IN_ALL
217 GByteArray
* g_byte_array_remove_index (GByteArray
*array
,
219 GLIB_AVAILABLE_IN_ALL
220 GByteArray
* g_byte_array_remove_index_fast (GByteArray
*array
,
222 GLIB_AVAILABLE_IN_ALL
223 GByteArray
* g_byte_array_remove_range (GByteArray
*array
,
226 GLIB_AVAILABLE_IN_ALL
227 void g_byte_array_sort (GByteArray
*array
,
228 GCompareFunc compare_func
);
229 GLIB_AVAILABLE_IN_ALL
230 void g_byte_array_sort_with_data (GByteArray
*array
,
231 GCompareDataFunc compare_func
,
236 #endif /* __G_ARRAY_H__ */