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 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION) 28 #error "Only <glib.h> can be included directly." 29 #endif 30 31 #ifndef __G_ARRAY_H__ 32 #define __G_ARRAY_H__ 33 34 #include <glib/gtypes.h> 35 36 G_BEGIN_DECLS 37 38 typedef struct _GArray GArray; 39 typedef struct _GByteArray GByteArray; 40 typedef struct _GPtrArray GPtrArray; 41 42 struct _GArray 43 { 44 gchar *data; 45 guint len; 46 }; 47 48 struct _GByteArray 49 { 50 guint8 *data; 51 guint len; 52 }; 53 54 struct _GPtrArray 55 { 56 gpointer *pdata; 57 guint len; 58 }; 59 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. 63 */ 64 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)]) 69 70 GArray* g_array_new (gboolean zero_terminated, 71 gboolean clear_, 72 guint element_size); 73 GArray* g_array_sized_new (gboolean zero_terminated, 74 gboolean clear_, 75 guint element_size, 76 guint reserved_size); 77 gchar* g_array_free (GArray *array, 78 gboolean free_segment); 79 GArray* g_array_append_vals (GArray *array, 80 gconstpointer data, 81 guint len); 82 GArray* g_array_prepend_vals (GArray *array, 83 gconstpointer data, 84 guint len); 85 GArray* g_array_insert_vals (GArray *array, 86 guint index_, 87 gconstpointer data, 88 guint len); 89 GArray* g_array_set_size (GArray *array, 90 guint length); 91 GArray* g_array_remove_index (GArray *array, 92 guint index_); 93 GArray* g_array_remove_index_fast (GArray *array, 94 guint index_); 95 GArray* g_array_remove_range (GArray *array, 96 guint index_, 97 guint length); 98 void g_array_sort (GArray *array, 99 GCompareFunc compare_func); 100 void g_array_sort_with_data (GArray *array, 101 GCompareDataFunc compare_func, 102 gpointer user_data); 103 104 /* Resizable pointer array. This interface is much less complicated 105 * than the above. Add appends a pointer. Remove fills any cleared 106 * spot and shortens the array. remove_fast will again distort order. 107 */ 108 #define g_ptr_array_index(array,index_) ((array)->pdata)[index_] 109 GPtrArray* g_ptr_array_new (void); 110 GPtrArray* g_ptr_array_sized_new (guint reserved_size); 111 gpointer* g_ptr_array_free (GPtrArray *array, 112 gboolean free_seg); 113 void g_ptr_array_set_size (GPtrArray *array, 114 gint length); 115 gpointer g_ptr_array_remove_index (GPtrArray *array, 116 guint index_); 117 gpointer g_ptr_array_remove_index_fast (GPtrArray *array, 118 guint index_); 119 gboolean g_ptr_array_remove (GPtrArray *array, 120 gpointer data); 121 gboolean g_ptr_array_remove_fast (GPtrArray *array, 122 gpointer data); 123 void g_ptr_array_remove_range (GPtrArray *array, 124 guint index_, 125 guint length); 126 void g_ptr_array_add (GPtrArray *array, 127 gpointer data); 128 void g_ptr_array_sort (GPtrArray *array, 129 GCompareFunc compare_func); 130 void g_ptr_array_sort_with_data (GPtrArray *array, 131 GCompareDataFunc compare_func, 132 gpointer user_data); 133 void g_ptr_array_foreach (GPtrArray *array, 134 GFunc func, 135 gpointer user_data); 136 137 138 /* Byte arrays, an array of guint8. Implemented as a GArray, 139 * but type-safe. 140 */ 141 142 GByteArray* g_byte_array_new (void); 143 GByteArray* g_byte_array_sized_new (guint reserved_size); 144 guint8* g_byte_array_free (GByteArray *array, 145 gboolean free_segment); 146 GByteArray* g_byte_array_append (GByteArray *array, 147 const guint8 *data, 148 guint len); 149 GByteArray* g_byte_array_prepend (GByteArray *array, 150 const guint8 *data, 151 guint len); 152 GByteArray* g_byte_array_set_size (GByteArray *array, 153 guint length); 154 GByteArray* g_byte_array_remove_index (GByteArray *array, 155 guint index_); 156 GByteArray* g_byte_array_remove_index_fast (GByteArray *array, 157 guint index_); 158 GByteArray* g_byte_array_remove_range (GByteArray *array, 159 guint index_, 160 guint length); 161 void g_byte_array_sort (GByteArray *array, 162 GCompareFunc compare_func); 163 void g_byte_array_sort_with_data (GByteArray *array, 164 GCompareDataFunc compare_func, 165 gpointer user_data); 166 167 G_END_DECLS 168 169 #endif /* __G_ARRAY_H__ */ 170