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/.
27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
34 #include <glib/gtypes.h>
38 typedef struct _GArray GArray
;
39 typedef struct _GByteArray GByteArray
;
40 typedef struct _GPtrArray GPtrArray
;
60 /* Resizable arrays. remove fills any cleared spot and shortens the
61 * array, while preserving the order. remove_fast will distort the
62 * order by moving the last element to the position of the removed.
65 #define g_array_append_val(a,v) g_array_append_vals (a, &(v), 1)
66 #define g_array_prepend_val(a,v) g_array_prepend_vals (a, &(v), 1)
67 #define g_array_insert_val(a,i,v) g_array_insert_vals (a, i, &(v), 1)
68 #define g_array_index(a,t,i) (((t*) (void *) (a)->data) [(i)])
70 GArray
* g_array_new (gboolean zero_terminated
,
73 GArray
* g_array_sized_new (gboolean zero_terminated
,
77 gchar
* g_array_free (GArray
*array
,
78 gboolean free_segment
);
79 GArray
*g_array_ref (GArray
*array
);
80 void g_array_unref (GArray
*array
);
81 guint
g_array_get_element_size (GArray
*array
);
82 GArray
* g_array_append_vals (GArray
*array
,
85 GArray
* g_array_prepend_vals (GArray
*array
,
88 GArray
* g_array_insert_vals (GArray
*array
,
92 GArray
* g_array_set_size (GArray
*array
,
94 GArray
* g_array_remove_index (GArray
*array
,
96 GArray
* g_array_remove_index_fast (GArray
*array
,
98 GArray
* g_array_remove_range (GArray
*array
,
101 void g_array_sort (GArray
*array
,
102 GCompareFunc compare_func
);
103 void g_array_sort_with_data (GArray
*array
,
104 GCompareDataFunc compare_func
,
107 /* Resizable pointer array. This interface is much less complicated
108 * than the above. Add appends a pointer. Remove fills any cleared
109 * spot and shortens the array. remove_fast will again distort order.
111 #define g_ptr_array_index(array,index_) ((array)->pdata)[index_]
112 GPtrArray
* g_ptr_array_new (void);
113 GPtrArray
* g_ptr_array_new_with_free_func (GDestroyNotify element_free_func
);
114 GPtrArray
* g_ptr_array_sized_new (guint reserved_size
);
115 gpointer
* g_ptr_array_free (GPtrArray
*array
,
117 GPtrArray
* g_ptr_array_ref (GPtrArray
*array
);
118 void g_ptr_array_unref (GPtrArray
*array
);
119 void g_ptr_array_set_free_func (GPtrArray
*array
,
120 GDestroyNotify element_free_func
);
121 void g_ptr_array_set_size (GPtrArray
*array
,
123 gpointer
g_ptr_array_remove_index (GPtrArray
*array
,
125 gpointer
g_ptr_array_remove_index_fast (GPtrArray
*array
,
127 gboolean
g_ptr_array_remove (GPtrArray
*array
,
129 gboolean
g_ptr_array_remove_fast (GPtrArray
*array
,
131 void g_ptr_array_remove_range (GPtrArray
*array
,
134 void g_ptr_array_add (GPtrArray
*array
,
136 void g_ptr_array_sort (GPtrArray
*array
,
137 GCompareFunc compare_func
);
138 void g_ptr_array_sort_with_data (GPtrArray
*array
,
139 GCompareDataFunc compare_func
,
141 void g_ptr_array_foreach (GPtrArray
*array
,
146 /* Byte arrays, an array of guint8. Implemented as a GArray,
150 GByteArray
* g_byte_array_new (void);
151 GByteArray
* g_byte_array_sized_new (guint reserved_size
);
152 guint8
* g_byte_array_free (GByteArray
*array
,
153 gboolean free_segment
);
154 GByteArray
*g_byte_array_ref (GByteArray
*array
);
155 void g_byte_array_unref (GByteArray
*array
);
156 GByteArray
* g_byte_array_append (GByteArray
*array
,
159 GByteArray
* g_byte_array_prepend (GByteArray
*array
,
162 GByteArray
* g_byte_array_set_size (GByteArray
*array
,
164 GByteArray
* g_byte_array_remove_index (GByteArray
*array
,
166 GByteArray
* g_byte_array_remove_index_fast (GByteArray
*array
,
168 GByteArray
* g_byte_array_remove_range (GByteArray
*array
,
171 void g_byte_array_sort (GByteArray
*array
,
172 GCompareFunc compare_func
);
173 void g_byte_array_sort_with_data (GByteArray
*array
,
174 GCompareDataFunc compare_func
,
179 #endif /* __G_ARRAY_H__ */