glib/garray.c

   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 /*
  28  * MT safe
  29  */
  30
  31 #include "config.h"
  32
  33 #include <string.h>
  34 #include <stdlib.h>
  35
  36 #include "garray.h"
  37
  38 #include "gmem.h"
  39 #include "gthread.h"
  40 #include "gmessages.h"
  41 #include "gqsort.h"
  42
  43
  44 /**
  45  * SECTION:arrays
  46  * @title: Arrays
  47  * @short_description: arrays of arbitrary elements which grow
  48  *                     automatically as elements are added
  49  *
  50  * Arrays are similar to standard C arrays, except that they grow
  51  * automatically as elements are added.
  52  *
  53  * Array elements can be of any size (though all elements of one array
  54  * are the same size), and the array can be automatically cleared to
  55  * '0's and zero-terminated.
  56  *
  57  * To create a new array use g_array_new().
  58  *
  59  * To add elements to an array, use g_array_append_val(),
  60  * g_array_append_vals(), g_array_prepend_val(), and
  61  * g_array_prepend_vals().
  62  *
  63  * To access an element of an array, use g_array_index().
  64  *
  65  * To set the size of an array, use g_array_set_size().
  66  *
  67  * To free an array, use g_array_free().
  68  *
  69  * <example>
  70  *  <title>Using a #GArray to store #gint values</title>
  71  *  <programlisting>
  72  *   GArray *garray;
  73  *   gint i;
  74  *   /<!-- -->* We create a new array to store gint values.
  75  *      We don't want it zero-terminated or cleared to 0's. *<!-- -->/
  76  *   garray = g_array_new (FALSE, FALSE, sizeof (gint));
  77  *   for (i = 0; i &lt; 10000; i++)
  78  *     g_array_append_val (garray, i);
  79  *   for (i = 0; i &lt; 10000; i++)
  80  *     if (g_array_index (garray, gint, i) != i)
  81  *       g_print ("ERROR: got &percnt;d instead of &percnt;d\n",
  82  *                g_array_index (garray, gint, i), i);
  83  *   g_array_free (garray, TRUE);
  84  *  </programlisting>
  85  * </example>
  86  **/
  87
  88 #define MIN_ARRAY_SIZE  16
  89
  90 typedef struct _GRealArray  GRealArray;
  91
  92 /**
  93  * GArray:
  94  * @data: a pointer to the element data. The data may be moved as
  95  *        elements are added to the #GArray.
  96  * @len: the number of elements in the #GArray not including the
  97  *       possible terminating zero element.
  98  *
  99  * Contains the public fields of an <link
 100  * linkend="glib-arrays">Array</link>.
 101  **/
 102 struct _GRealArray
 103 {
 104   guint8 *data;
 105   guint   len;
 106   guint   alloc;
 107   guint   elt_size;
 108   guint   zero_terminated : 1;
 109   guint   clear : 1;
 110   volatile gint ref_count;
 111 };
 112
 113 /**
 114  * g_array_index:
 115  * @a: a #GArray.
 116  * @t: the type of the elements.
 117  * @i: the index of the element to return.
 118  * @Returns: the element of the #GArray at the index given by @i.
 119  *
 120  * Returns the element of a #GArray at the given index. The return
 121  * value is cast to the given type.
 122  *
 123  * <example>
 124  *  <title>Getting a pointer to an element in a #GArray</title>
 125  *  <programlisting>
 126  *   EDayViewEvent *event;
 127  *   /<!-- -->* This gets a pointer to the 4th element
 128  *      in the array of EDayViewEvent structs. *<!-- -->/
 129  *   event = &amp;g_array_index (events, EDayViewEvent, 3);
 130  *  </programlisting>
 131  * </example>
 132  **/
 133
 134 #define g_array_elt_len(array,i) ((array)->elt_size * (i))
 135 #define g_array_elt_pos(array,i) ((array)->data + g_array_elt_len((array),(i)))
 136 #define g_array_elt_zero(array, pos, len)                               \
 137   (memset (g_array_elt_pos ((array), pos), 0,  g_array_elt_len ((array), len)))
 138 #define g_array_zero_terminate(array) G_STMT_START{                     \
 139   if ((array)->zero_terminated)                                         \
 140     g_array_elt_zero ((array), (array)->len, 1);                        \
 141 }G_STMT_END
 142
 143 static guint g_nearest_pow        (gint        num) G_GNUC_CONST;
 144 static void  g_array_maybe_expand (GRealArray *array,
 145                                    gint        len);
 146
 147 /**
 148  * g_array_new:
 149  * @zero_terminated: %TRUE if the array should have an extra element at
 150  *                   the end which is set to 0.
 151  * @clear_: %TRUE if #GArray elements should be automatically cleared
 152  *          to 0 when they are allocated.
 153  * @element_size: the size of each element in bytes.
 154  * @Returns: the new #GArray.
 155  *
 156  * Creates a new #GArray with a reference count of 1.
 157  **/
 158 GArray*
 159 g_array_new (gboolean zero_terminated,
 160              gboolean clear,
 161              guint    elt_size)
 162 {
 163   return (GArray*) g_array_sized_new (zero_terminated, clear, elt_size, 0);
 164 }
 165
 166 /**
 167  * g_array_sized_new:
 168  * @zero_terminated: %TRUE if the array should have an extra element at
 169  *                   the end with all bits cleared.
 170  * @clear_: %TRUE if all bits in the array should be cleared to 0 on
 171  *          allocation.
 172  * @element_size: size of each element in the array.
 173  * @reserved_size: number of elements preallocated.
 174  * @Returns: the new #GArray.
 175  *
 176  * Creates a new #GArray with @reserved_size elements preallocated and
 177  * a reference count of 1. This avoids frequent reallocation, if you
 178  * are going to add many elements to the array. Note however that the
 179  * size of the array is still 0.
 180  **/
 181 GArray* g_array_sized_new (gboolean zero_terminated,
 182                            gboolean clear,
 183                            guint    elt_size,
 184                            guint    reserved_size)
 185 {
 186   GRealArray *array = g_slice_new (GRealArray);
 187
 188   array->data            = NULL;
 189   array->len             = 0;
 190   array->alloc           = 0;
 191   array->zero_terminated = (zero_terminated ? 1 : 0);
 192   array->clear           = (clear ? 1 : 0);
 193   array->elt_size        = elt_size;
 194   array->ref_count       = 1;
 195
 196   if (array->zero_terminated || reserved_size != 0)
 197     {
 198       g_array_maybe_expand (array, reserved_size);
 199       g_array_zero_terminate(array);
 200     }
 201
 202   return (GArray*) array;
 203 }
 204
 205 /**
 206  * g_array_ref:
 207  * @array: A #GArray.
 208  *
 209  * Atomically increments the reference count of @array by one. This
 210  * function is MT-safe and may be called from any thread.
 211  *
 212  * Returns: The passed in #GArray.
 213  *
 214  * Since: 2.22
 215  **/
 216 GArray *
 217 g_array_ref (GArray *array)
 218 {
 219   GRealArray *rarray = (GRealArray*) array;
 220   g_return_val_if_fail (array, NULL);
 221
 222   g_atomic_int_inc (&rarray->ref_count);
 223
 224   return array;
 225 }
 226
 227 /**
 228  * g_array_unref:
 229  * @array: A #GArray.
 230  *
 231  * Atomically decrements the reference count of @array by one. If the
 232  * reference count drops to 0, all memory allocated by the array is
 233  * released. This function is MT-safe and may be called from any
 234  * thread.
 235  *
 236  * Since: 2.22
 237  **/
 238 void
 239 g_array_unref (GArray *array)
 240 {
 241   GRealArray *rarray = (GRealArray*) array;
 242   g_return_if_fail (array);
 243
 244   if (g_atomic_int_dec_and_test (&rarray->ref_count))
 245     g_array_free (array, TRUE);
 246 }
 247
 248 /**
 249  * g_array_get_element_size:
 250  * @array: A #GArray.
 251  *
 252  * Gets the size of the elements in @array.
 253  *
 254  * Returns: Size of each element, in bytes.
 255  *
 256  * Since: 2.22
 257  **/
 258 guint
 259 g_array_get_element_size (GArray *array)
 260 {
 261   GRealArray *rarray = (GRealArray*) array;
 262
 263   g_return_val_if_fail (array, 0);
 264
 265   return rarray->elt_size;
 266 }
 267
 268 /**
 269  * g_array_free:
 270  * @array: a #GArray.
 271  * @free_segment: if %TRUE the actual element data is freed as well.
 272  * @Returns: the element data if @free_segment is %FALSE, otherwise
 273  *           %NULL.  The element data should be freed using g_free().
 274  *
 275  * Frees the memory allocated for the #GArray. If @free_segment is
 276  * %TRUE it frees the memory block holding the elements as well and
 277  * also each element if @array has a @element_free_func set. Pass
 278  * %FALSE if you want to free the #GArray wrapper but preserve the
 279  * underlying array for use elsewhere. If the reference count of @array
 280  * is greater than one, the #GArray wrapper is preserved but the size
 281  * of @array will be set to zero.
 282  *
 283  * <note><para>If array elements contain dynamically-allocated memory,
 284  * they should be freed separately.</para></note>
 285  **/
 286 gchar*
 287 g_array_free (GArray   *farray,
 288               gboolean  free_segment)
 289 {
 290   GRealArray *array = (GRealArray*) farray;
 291   gchar* segment;
 292   gboolean preserve_wrapper;
 293
 294   g_return_val_if_fail (array, NULL);
 295
 296   /* if others are holding a reference, preserve the wrapper but do free/return the data */
 297   preserve_wrapper = FALSE;
 298   if (g_atomic_int_get (&array->ref_count) > 1)
 299     preserve_wrapper = TRUE;
 300
 301   if (free_segment)
 302     {
 303       g_free (array->data);
 304       segment = NULL;
 305     }
 306   else
 307     segment = (gchar*) array->data;
 308
 309   if (preserve_wrapper)
 310     {
 311       array->data            = NULL;
 312       array->len             = 0;
 313       array->alloc           = 0;
 314     }
 315   else
 316     {
 317       g_slice_free1 (sizeof (GRealArray), array);
 318     }
 319
 320   return segment;
 321 }
 322
 323 /**
 324  * g_array_append_vals:
 325  * @array: a #GArray.
 326  * @data: a pointer to the elements to append to the end of the array.
 327  * @len: the number of elements to append.
 328  * @Returns: the #GArray.
 329  *
 330  * Adds @len elements onto the end of the array.
 331  **/
 332 /**
 333  * g_array_append_val:
 334  * @a: a #GArray.
 335  * @v: the value to append to the #GArray.
 336  * @Returns: the #GArray.
 337  *
 338  * Adds the value on to the end of the array. The array will grow in
 339  * size automatically if necessary.
 340  *
 341  * <note><para>g_array_append_val() is a macro which uses a reference
 342  * to the value parameter @v. This means that you cannot use it with
 343  * literal values such as "27". You must use variables.</para></note>
 344  **/
 345 GArray*
 346 g_array_append_vals (GArray       *farray,
 347                      gconstpointer data,
 348                      guint         len)
 349 {
 350   GRealArray *array = (GRealArray*) farray;
 351
 352   g_return_val_if_fail (array, NULL);
 353
 354   g_array_maybe_expand (array, len);
 355
 356   memcpy (g_array_elt_pos (array, array->len), data,
 357           g_array_elt_len (array, len));
 358
 359   array->len += len;
 360
 361   g_array_zero_terminate (array);
 362
 363   return farray;
 364 }
 365
 366 /**
 367  * g_array_prepend_vals:
 368  * @array: a #GArray.
 369  * @data: a pointer to the elements to prepend to the start of the
 370  *        array.
 371  * @len: the number of elements to prepend.
 372  * @Returns: the #GArray.
 373  *
 374  * Adds @len elements onto the start of the array.
 375  *
 376  * This operation is slower than g_array_append_vals() since the
 377  * existing elements in the array have to be moved to make space for
 378  * the new elements.
 379  **/
 380 /**
 381  * g_array_prepend_val:
 382  * @a: a #GArray.
 383  * @v: the value to prepend to the #GArray.
 384  * @Returns: the #GArray.
 385  *
 386  * Adds the value on to the start of the array. The array will grow in
 387  * size automatically if necessary.
 388  *
 389  * This operation is slower than g_array_append_val() since the
 390  * existing elements in the array have to be moved to make space for
 391  * the new element.
 392  *
 393  * <note><para>g_array_prepend_val() is a macro which uses a reference
 394  * to the value parameter @v. This means that you cannot use it with
 395  * literal values such as "27". You must use variables.</para></note>
 396  **/
 397 GArray*
 398 g_array_prepend_vals (GArray        *farray,
 399                       gconstpointer  data,
 400                       guint          len)
 401 {
 402   GRealArray *array = (GRealArray*) farray;
 403
 404   g_return_val_if_fail (array, NULL);
 405
 406   g_array_maybe_expand (array, len);
 407
 408   g_memmove (g_array_elt_pos (array, len), g_array_elt_pos (array, 0),
 409              g_array_elt_len (array, array->len));
 410
 411   memcpy (g_array_elt_pos (array, 0), data, g_array_elt_len (array, len));
 412
 413   array->len += len;
 414
 415   g_array_zero_terminate (array);
 416
 417   return farray;
 418 }
 419
 420 /**
 421  * g_array_insert_vals:
 422  * @array: a #GArray.
 423  * @index_: the index to place the elements at.
 424  * @data: a pointer to the elements to insert.
 425  * @len: the number of elements to insert.
 426  * @Returns: the #GArray.
 427  *
 428  * Inserts @len elements into a #GArray at the given index.
 429  **/
 430 /**
 431  * g_array_insert_val:
 432  * @a: a #GArray.
 433  * @i: the index to place the element at.
 434  * @v: the value to insert into the array.
 435  * @Returns: the #GArray.
 436  *
 437  * Inserts an element into an array at the given index.
 438  *
 439  * <note><para>g_array_insert_val() is a macro which uses a reference
 440  * to the value parameter @v. This means that you cannot use it with
 441  * literal values such as "27". You must use variables.</para></note>
 442  **/
 443 GArray*
 444 g_array_insert_vals (GArray        *farray,
 445                      guint          index_,
 446                      gconstpointer  data,
 447                      guint          len)
 448 {
 449   GRealArray *array = (GRealArray*) farray;
 450
 451   g_return_val_if_fail (array, NULL);
 452
 453   g_array_maybe_expand (array, len);
 454
 455   g_memmove (g_array_elt_pos (array, len + index_),
 456              g_array_elt_pos (array, index_),
 457              g_array_elt_len (array, array->len - index_));
 458
 459   memcpy (g_array_elt_pos (array, index_), data, g_array_elt_len (array, len));
 460
 461   array->len += len;
 462
 463   g_array_zero_terminate (array);
 464
 465   return farray;
 466 }
 467
 468 /**
 469  * g_array_set_size:
 470  * @array: a #GArray.
 471  * @length: the new size of the #GArray.
 472  * @Returns: the #GArray.
 473  *
 474  * Sets the size of the array, expanding it if necessary. If the array
 475  * was created with @clear_ set to %TRUE, the new elements are set to 0.
 476  **/
 477 GArray*
 478 g_array_set_size (GArray *farray,
 479                   guint   length)
 480 {
 481   GRealArray *array = (GRealArray*) farray;
 482
 483   g_return_val_if_fail (array, NULL);
 484
 485   if (length > array->len)
 486     {
 487       g_array_maybe_expand (array, length - array->len);
 488
 489       if (array->clear)
 490         g_array_elt_zero (array, array->len, length - array->len);
 491     }
 492   else if (G_UNLIKELY (g_mem_gc_friendly) && length < array->len)
 493     g_array_elt_zero (array, length, array->len - length);
 494
 495   array->len = length;
 496
 497   g_array_zero_terminate (array);
 498
 499   return farray;
 500 }
 501
 502 /**
 503  * g_array_remove_index:
 504  * @array: a #GArray.
 505  * @index_: the index of the element to remove.
 506  * @Returns: the #GArray.
 507  *
 508  * Removes the element at the given index from a #GArray. The following
 509  * elements are moved down one place.
 510  **/
 511 GArray*
 512 g_array_remove_index (GArray *farray,
 513                       guint   index_)
 514 {
 515   GRealArray* array = (GRealArray*) farray;
 516
 517   g_return_val_if_fail (array, NULL);
 518
 519   g_return_val_if_fail (index_ < array->len, NULL);
 520
 521   if (index_ != array->len - 1)
 522     g_memmove (g_array_elt_pos (array, index_),
 523                g_array_elt_pos (array, index_ + 1),
 524                g_array_elt_len (array, array->len - index_ - 1));
 525
 526   array->len -= 1;
 527
 528   if (G_UNLIKELY (g_mem_gc_friendly))
 529     g_array_elt_zero (array, array->len, 1);
 530   else
 531     g_array_zero_terminate (array);
 532
 533   return farray;
 534 }
 535
 536 /**
 537  * g_array_remove_index_fast:
 538  * @array: a @GArray.
 539  * @index_: the index of the element to remove.
 540  * @Returns: the #GArray.
 541  *
 542  * Removes the element at the given index from a #GArray. The last
 543  * element in the array is used to fill in the space, so this function
 544  * does not preserve the order of the #GArray. But it is faster than
 545  * g_array_remove_index().
 546  **/
 547 GArray*
 548 g_array_remove_index_fast (GArray *farray,
 549                            guint   index_)
 550 {
 551   GRealArray* array = (GRealArray*) farray;
 552
 553   g_return_val_if_fail (array, NULL);
 554
 555   g_return_val_if_fail (index_ < array->len, NULL);
 556
 557   if (index_ != array->len - 1)
 558     memcpy (g_array_elt_pos (array, index_),
 559             g_array_elt_pos (array, array->len - 1),
 560             g_array_elt_len (array, 1));
 561
 562   array->len -= 1;
 563
 564   if (G_UNLIKELY (g_mem_gc_friendly))
 565     g_array_elt_zero (array, array->len, 1);
 566   else
 567     g_array_zero_terminate (array);
 568
 569   return farray;
 570 }
 571
 572 /**
 573  * g_array_remove_range:
 574  * @array: a @GArray.
 575  * @index_: the index of the first element to remove.
 576  * @length: the number of elements to remove.
 577  * @Returns: the #GArray.
 578  *
 579  * Removes the given number of elements starting at the given index
 580  * from a #GArray.  The following elements are moved to close the gap.
 581  *
 582  * Since: 2.4
 583  **/
 584 GArray*
 585 g_array_remove_range (GArray *farray,
 586                       guint   index_,
 587                       guint   length)
 588 {
 589   GRealArray *array = (GRealArray*) farray;
 590
 591   g_return_val_if_fail (array, NULL);
 592   g_return_val_if_fail (index_ < array->len, NULL);
 593   g_return_val_if_fail (index_ + length <= array->len, NULL);
 594
 595   if (index_ + length != array->len)
 596     g_memmove (g_array_elt_pos (array, index_),
 597                g_array_elt_pos (array, index_ + length),
 598                (array->len - (index_ + length)) * array->elt_size);
 599
 600   array->len -= length;
 601   if (G_UNLIKELY (g_mem_gc_friendly))
 602     g_array_elt_zero (array, array->len, length);
 603   else
 604     g_array_zero_terminate (array);
 605
 606   return farray;
 607 }
 608
 609 /**
 610  * g_array_sort:
 611  * @array: a #GArray.
 612  * @compare_func: comparison function.
 613  *
 614  * Sorts a #GArray using @compare_func which should be a qsort()-style
 615  * comparison function (returns less than zero for first arg is less
 616  * than second arg, zero for equal, greater zero if first arg is
 617  * greater than second arg).
 618  *
 619  * If two array elements compare equal, their order in the sorted array
 620  * is undefined. If you want equal elements to keep their order &#8211; i.e.
 621  * you want a stable sort &#8211; you can write a comparison function that,
 622  * if two elements would otherwise compare equal, compares them by
 623  * their addresses.
 624  **/
 625 void
 626 g_array_sort (GArray       *farray,
 627               GCompareFunc  compare_func)
 628 {
 629   GRealArray *array = (GRealArray*) farray;
 630
 631   g_return_if_fail (array != NULL);
 632
 633   qsort (array->data,
 634          array->len,
 635          array->elt_size,
 636          compare_func);
 637 }
 638
 639 /**
 640  * g_array_sort_with_data:
 641  * @array: a #GArray.
 642  * @compare_func: comparison function.
 643  * @user_data: data to pass to @compare_func.
 644  *
 645  * Like g_array_sort(), but the comparison function receives an extra
 646  * user data argument.
 647  **/
 648 void
 649 g_array_sort_with_data (GArray           *farray,
 650                         GCompareDataFunc  compare_func,
 651                         gpointer          user_data)
 652 {
 653   GRealArray *array = (GRealArray*) farray;
 654
 655   g_return_if_fail (array != NULL);
 656
 657   g_qsort_with_data (array->data,
 658                      array->len,
 659                      array->elt_size,
 660                      compare_func,
 661                      user_data);
 662 }
 663
 664 /* Returns the smallest power of 2 greater than n, or n if
 665  * such power does not fit in a guint
 666  */
 667 static guint
 668 g_nearest_pow (gint num)
 669 {
 670   guint n = 1;
 671
 672   while (n < num && n > 0)
 673     n <<= 1;
 674
 675   return n ? n : num;
 676 }
 677
 678 static void
 679 g_array_maybe_expand (GRealArray *array,
 680                       gint        len)
 681 {
 682   guint want_alloc = g_array_elt_len (array, array->len + len +
 683                                       array->zero_terminated);
 684
 685   if (want_alloc > array->alloc)
 686     {
 687       want_alloc = g_nearest_pow (want_alloc);
 688       want_alloc = MAX (want_alloc, MIN_ARRAY_SIZE);
 689
 690       array->data = g_realloc (array->data, want_alloc);
 691
 692       if (G_UNLIKELY (g_mem_gc_friendly))
 693         memset (array->data + array->alloc, 0, want_alloc - array->alloc);
 694
 695       array->alloc = want_alloc;
 696     }
 697 }
 698
 699 /**
 700  * SECTION:arrays_pointer
 701  * @title: Pointer Arrays
 702  * @short_description: arrays of pointers to any type of data, which
 703  *                     grow automatically as new elements are added
 704  *
 705  * Pointer Arrays are similar to Arrays but are used only for storing
 706  * pointers.
 707  *
 708  * <note><para>If you remove elements from the array, elements at the
 709  * end of the array are moved into the space previously occupied by the
 710  * removed element. This means that you should not rely on the index of
 711  * particular elements remaining the same. You should also be careful
 712  * when deleting elements while iterating over the array.</para></note>
 713  *
 714  * To create a pointer array, use g_ptr_array_new().
 715  *
 716  * To add elements to a pointer array, use g_ptr_array_add().
 717  *
 718  * To remove elements from a pointer array, use g_ptr_array_remove(),
 719  * g_ptr_array_remove_index() or g_ptr_array_remove_index_fast().
 720  *
 721  * To access an element of a pointer array, use g_ptr_array_index().
 722  *
 723  * To set the size of a pointer array, use g_ptr_array_set_size().
 724  *
 725  * To free a pointer array, use g_ptr_array_free().
 726  *
 727  * <example>
 728  *  <title>Using a #GPtrArray</title>
 729  *  <programlisting>
 730  *   GPtrArray *gparray;
 731  *   gchar *string1 = "one", *string2 = "two", *string3 = "three";
 732  *
 733  *   gparray = g_ptr_array_new (<!-- -->);
 734  *   g_ptr_array_add (gparray, (gpointer) string1);
 735  *   g_ptr_array_add (gparray, (gpointer) string2);
 736  *   g_ptr_array_add (gparray, (gpointer) string3);
 737  *
 738  *   if (g_ptr_array_index (gparray, 0) != (gpointer) string1)
 739  *     g_print ("ERROR: got &percnt;p instead of &percnt;p\n",
 740  *              g_ptr_array_index (gparray, 0), string1);
 741  *
 742  *   g_ptr_array_free (gparray, TRUE);
 743  *  </programlisting>
 744  * </example>
 745  **/
 746
 747 typedef struct _GRealPtrArray  GRealPtrArray;
 748
 749 /**
 750  * GPtrArray:
 751  * @pdata: points to the array of pointers, which may be moved when the
 752  *         array grows.
 753  * @len: number of pointers in the array.
 754  *
 755  * Contains the public fields of a pointer array.
 756  **/
 757 struct _GRealPtrArray
 758 {
 759   gpointer     *pdata;
 760   guint         len;
 761   guint         alloc;
 762   volatile gint ref_count;
 763   GDestroyNotify element_free_func;
 764 };
 765
 766 /**
 767  * g_ptr_array_index:
 768  * @array: a #GPtrArray.
 769  * @index_: the index of the pointer to return.
 770  * @Returns: the pointer at the given index.
 771  *
 772  * Returns the pointer at the given index of the pointer array.
 773  **/
 774
 775 static void g_ptr_array_maybe_expand (GRealPtrArray *array,
 776                                       gint           len);
 777
 778 /**
 779  * g_ptr_array_new:
 780  * @Returns: the new #GPtrArray.
 781  *
 782  * Creates a new #GPtrArray with a reference count of 1.
 783  **/
 784 GPtrArray*
 785 g_ptr_array_new (void)
 786 {
 787   return g_ptr_array_sized_new (0);
 788 }
 789
 790 /**
 791  * g_ptr_array_sized_new:
 792  * @reserved_size: number of pointers preallocated.
 793  * @Returns: the new #GPtrArray.
 794  *
 795  * Creates a new #GPtrArray with @reserved_size pointers preallocated
 796  * and a reference count of 1. This avoids frequent reallocation, if
 797  * you are going to add many pointers to the array. Note however that
 798  * the size of the array is still 0.
 799  **/
 800 GPtrArray*
 801 g_ptr_array_sized_new (guint reserved_size)
 802 {
 803   GRealPtrArray *array = g_slice_new (GRealPtrArray);
 804
 805   array->pdata = NULL;
 806   array->len = 0;
 807   array->alloc = 0;
 808   array->ref_count = 1;
 809   array->element_free_func = NULL;
 810
 811   if (reserved_size != 0)
 812     g_ptr_array_maybe_expand (array, reserved_size);
 813
 814   return (GPtrArray*) array;
 815 }
 816
 817 /**
 818  * g_ptr_array_new_with_free_func:
 819  * @element_free_func: A function to free elements with destroy @array or %NULL.
 820  *
 821  * Creates a new #GPtrArray with a reference count of 1 and use @element_free_func
 822  * for freeing each element when the array is destroyed either via
 823  * g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment
 824  * set to %TRUE or when removing elements.
 825  *
 826  * Returns: A new #GPtrArray.
 827  *
 828  * Since: 2.22
 829  **/
 830 GPtrArray *
 831 g_ptr_array_new_with_free_func (GDestroyNotify element_free_func)
 832 {
 833   GPtrArray *array;
 834
 835   array = g_ptr_array_new ();
 836   g_ptr_array_set_free_func (array, element_free_func);
 837   return array;
 838 }
 839
 840 /**
 841  * g_ptr_array_set_free_func:
 842  * @array: A #GPtrArray.
 843  * @element_free_func: A function to free elements with destroy @array or %NULL.
 844  *
 845  * Sets a function for freeing each element when @array is destroyed
 846  * either via g_ptr_array_unref(), when g_ptr_array_free() is called
 847  * with @free_segment set to %TRUE or when removing elements.
 848  *
 849  * Since: 2.22
 850  **/
 851 void
 852 g_ptr_array_set_free_func (GPtrArray        *array,
 853                            GDestroyNotify    element_free_func)
 854 {
 855   GRealPtrArray* rarray = (GRealPtrArray*) array;
 856
 857   g_return_if_fail (array);
 858
 859   rarray->element_free_func = element_free_func;
 860 }
 861
 862 /**
 863  * g_ptr_array_ref:
 864  * @array: A #GArray.
 865  *
 866  * Atomically increments the reference count of @array by one. This
 867  * function is MT-safe and may be called from any thread.
 868  *
 869  * Returns: The passed in #GPtrArray.
 870  *
 871  * Since: 2.22
 872  **/
 873 GPtrArray *
 874 g_ptr_array_ref (GPtrArray *array)
 875 {
 876   GRealPtrArray *rarray = (GRealPtrArray*) array;
 877
 878   g_return_val_if_fail (array, NULL);
 879
 880   g_atomic_int_inc (&rarray->ref_count);
 881
 882   return array;
 883 }
 884
 885 /**
 886  * g_ptr_array_unref:
 887  * @array: A #GPtrArray.
 888  *
 889  * Atomically decrements the reference count of @array by one. If the
 890  * reference count drops to 0, the effect is the same as calling
 891  * g_ptr_array_free() with @free_segment set to %TRUE. This function
 892  * is MT-safe and may be called from any thread.
 893  *
 894  * Since: 2.22
 895  **/
 896 void
 897 g_ptr_array_unref (GPtrArray *array)
 898 {
 899   GRealPtrArray *rarray = (GRealPtrArray*) array;
 900   g_return_if_fail (array);
 901
 902   if (g_atomic_int_dec_and_test (&rarray->ref_count))
 903     g_ptr_array_free (array, TRUE);
 904 }
 905
 906 /**
 907  * g_ptr_array_free:
 908  * @array: a #GPtrArray.
 909  * @free_seg: if %TRUE the actual pointer array is freed as well.
 910  * @Returns: the pointer array if @free_seg is %FALSE, otherwise %NULL.
 911  *           The pointer array should be freed using g_free().
 912  *
 913  * Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE
 914  * it frees the memory block holding the elements as well. Pass %FALSE
 915  * if you want to free the #GPtrArray wrapper but preserve the
 916  * underlying array for use elsewhere. If the reference count of @array
 917  * is greater than one, the #GPtrArray wrapper is preserved but the
 918  * size of @array will be set to zero.
 919  *
 920  * <note><para>If array contents point to dynamically-allocated
 921  * memory, they should be freed separately if @free_seg is %TRUE and no
 922  * #GDestroyNotify function has been set for @array.</para></note>
 923  **/
 924 gpointer*
 925 g_ptr_array_free (GPtrArray *farray,
 926                   gboolean   free_segment)
 927 {
 928   GRealPtrArray *array = (GRealPtrArray*) farray;
 929   gpointer* segment;
 930   gboolean preserve_wrapper;
 931
 932   g_return_val_if_fail (array, NULL);
 933
 934   /* if others are holding a reference, preserve the wrapper but do free/return the data */
 935   preserve_wrapper = FALSE;
 936   if (g_atomic_int_get (&array->ref_count) > 1)
 937     preserve_wrapper = TRUE;
 938
 939   if (free_segment)
 940     {
 941       if (array->element_free_func != NULL)
 942         g_ptr_array_foreach (farray, (GFunc) array->element_free_func, NULL);
 943       g_free (array->pdata);
 944       segment = NULL;
 945     }
 946   else
 947     segment = array->pdata;
 948
 949   if (preserve_wrapper)
 950     {
 951       array->pdata = NULL;
 952       array->len = 0;
 953       array->alloc = 0;
 954     }
 955   else
 956     {
 957       g_slice_free1 (sizeof (GRealPtrArray), array);
 958     }
 959
 960   return segment;
 961 }
 962
 963 static void
 964 g_ptr_array_maybe_expand (GRealPtrArray *array,
 965                           gint           len)
 966 {
 967   if ((array->len + len) > array->alloc)
 968     {
 969       guint old_alloc = array->alloc;
 970       array->alloc = g_nearest_pow (array->len + len);
 971       array->alloc = MAX (array->alloc, MIN_ARRAY_SIZE);
 972       array->pdata = g_realloc (array->pdata, sizeof (gpointer) * array->alloc);
 973       if (G_UNLIKELY (g_mem_gc_friendly))
 974         for ( ; old_alloc < array->alloc; old_alloc++)
 975           array->pdata [old_alloc] = NULL;
 976     }
 977 }
 978
 979 /**
 980  * g_ptr_array_set_size:
 981  * @array: a #GPtrArray.
 982  * @length: the new length of the pointer array.
 983  *
 984  * Sets the size of the array. When making the array larger,
 985  * newly-added elements will be set to %NULL. When making it smaller,
 986  * if @array has a non-%NULL #GDestroyNotify function then it will be
 987  * called for the removed elements.
 988  **/
 989 void
 990 g_ptr_array_set_size  (GPtrArray *farray,
 991                        gint       length)
 992 {
 993   GRealPtrArray* array = (GRealPtrArray*) farray;
 994
 995   g_return_if_fail (array);
 996
 997   if (length > array->len)
 998     {
 999       int i;
1000       g_ptr_array_maybe_expand (array, (length - array->len));
1001       /* This is not
1002        *     memset (array->pdata + array->len, 0,
1003        *            sizeof (gpointer) * (length - array->len));
1004        * to make it really portable. Remember (void*)NULL needn't be
1005        * bitwise zero. It of course is silly not to use memset (..,0,..).
1006        */
1007       for (i = array->len; i < length; i++)
1008         array->pdata[i] = NULL;
1009     }
1010   else if (length < array->len)
1011     g_ptr_array_remove_range (farray, length, array->len - length);
1012
1013   array->len = length;
1014 }
1015
1016 /**
1017  * g_ptr_array_remove_index:
1018  * @array: a #GPtrArray.
1019  * @index_: the index of the pointer to remove.
1020  * @Returns: the pointer which was removed.
1021  *
1022  * Removes the pointer at the given index from the pointer array. The
1023  * following elements are moved down one place. If @array has a
1024  * non-%NULL #GDestroyNotify function it is called for the removed
1025  * element.
1026  **/
1027 gpointer
1028 g_ptr_array_remove_index (GPtrArray *farray,
1029                           guint      index_)
1030 {
1031   GRealPtrArray* array = (GRealPtrArray*) farray;
1032   gpointer result;
1033
1034   g_return_val_if_fail (array, NULL);
1035
1036   g_return_val_if_fail (index_ < array->len, NULL);
1037
1038   result = array->pdata[index_];
1039
1040   if (array->element_free_func != NULL)
1041     array->element_free_func (array->pdata[index_]);
1042
1043   if (index_ != array->len - 1)
1044     g_memmove (array->pdata + index_, array->pdata + index_ + 1,
1045                sizeof (gpointer) * (array->len - index_ - 1));
1046
1047   array->len -= 1;
1048
1049   if (G_UNLIKELY (g_mem_gc_friendly))
1050     array->pdata[array->len] = NULL;
1051
1052   return result;
1053 }
1054
1055 /**
1056  * g_ptr_array_remove_index_fast:
1057  * @array: a #GPtrArray.
1058  * @index_: the index of the pointer to remove.
1059  * @Returns: the pointer which was removed.
1060  *
1061  * Removes the pointer at the given index from the pointer array. The
1062  * last element in the array is used to fill in the space, so this
1063  * function does not preserve the order of the array. But it is faster
1064  * than g_ptr_array_remove_index(). If @array has a non-%NULL
1065  * #GDestroyNotify function it is called for the removed element.
1066  **/
1067 gpointer
1068 g_ptr_array_remove_index_fast (GPtrArray *farray,
1069                                guint      index_)
1070 {
1071   GRealPtrArray* array = (GRealPtrArray*) farray;
1072   gpointer result;
1073
1074   g_return_val_if_fail (array, NULL);
1075
1076   g_return_val_if_fail (index_ < array->len, NULL);
1077
1078   result = array->pdata[index_];
1079
1080   if (array->element_free_func != NULL)
1081     array->element_free_func (array->pdata[index_]);
1082
1083   if (index_ != array->len - 1)
1084     array->pdata[index_] = array->pdata[array->len - 1];
1085
1086   array->len -= 1;
1087
1088   if (G_UNLIKELY (g_mem_gc_friendly))
1089     array->pdata[array->len] = NULL;
1090
1091   return result;
1092 }
1093
1094 /**
1095  * g_ptr_array_remove_range:
1096  * @array: a @GPtrArray.
1097  * @index_: the index of the first pointer to remove.
1098  * @length: the number of pointers to remove.
1099  *
1100  * Removes the given number of pointers starting at the given index
1101  * from a #GPtrArray.  The following elements are moved to close the
1102  * gap. If @array has a non-%NULL #GDestroyNotify function it is called
1103  * for the removed elements.
1104  *
1105  * Since: 2.4
1106  **/
1107 void
1108 g_ptr_array_remove_range (GPtrArray *farray,
1109                           guint      index_,
1110                           guint      length)
1111 {
1112   GRealPtrArray* array = (GRealPtrArray*) farray;
1113   guint n;
1114
1115   g_return_if_fail (array);
1116   g_return_if_fail (index_ < array->len);
1117   g_return_if_fail (index_ + length <= array->len);
1118
1119   if (array->element_free_func != NULL)
1120     {
1121       for (n = index_; n < index_ + length; n++)
1122         array->element_free_func (array->pdata[n]);
1123     }
1124
1125   if (index_ + length != array->len)
1126     {
1127       g_memmove (&array->pdata[index_],
1128                  &array->pdata[index_ + length],
1129                  (array->len - (index_ + length)) * sizeof (gpointer));
1130     }
1131
1132   array->len -= length;
1133   if (G_UNLIKELY (g_mem_gc_friendly))
1134     {
1135       guint i;
1136       for (i = 0; i < length; i++)
1137         array->pdata[array->len + i] = NULL;
1138     }
1139 }
1140
1141 /**
1142  * g_ptr_array_remove:
1143  * @array: a #GPtrArray.
1144  * @data: the pointer to remove.
1145  * @Returns: %TRUE if the pointer is removed. %FALSE if the pointer is
1146  *           not found in the array.
1147  *
1148  * Removes the first occurrence of the given pointer from the pointer
1149  * array. The following elements are moved down one place. If @array
1150  * has a non-%NULL #GDestroyNotify function it is called for the
1151  * removed element.
1152  *
1153  * It returns %TRUE if the pointer was removed, or %FALSE if the
1154  * pointer was not found.
1155  **/
1156 gboolean
1157 g_ptr_array_remove (GPtrArray *farray,
1158                     gpointer   data)
1159 {
1160   GRealPtrArray* array = (GRealPtrArray*) farray;
1161   guint i;
1162
1163   g_return_val_if_fail (array, FALSE);
1164
1165   for (i = 0; i < array->len; i += 1)
1166     {
1167       if (array->pdata[i] == data)
1168         {
1169           g_ptr_array_remove_index (farray, i);
1170           return TRUE;
1171         }
1172     }
1173
1174   return FALSE;
1175 }
1176
1177 /**
1178  * g_ptr_array_remove_fast:
1179  * @array: a #GPtrArray.
1180  * @data: the pointer to remove.
1181  * @Returns: %TRUE if the pointer was found in the array.
1182  *
1183  * Removes the first occurrence of the given pointer from the pointer
1184  * array. The last element in the array is used to fill in the space,
1185  * so this function does not preserve the order of the array. But it is
1186  * faster than g_ptr_array_remove(). If @array has a non-%NULL
1187  * #GDestroyNotify function it is called for the removed element.
1188  *
1189  * It returns %TRUE if the pointer was removed, or %FALSE if the
1190  * pointer was not found.
1191  **/
1192 gboolean
1193 g_ptr_array_remove_fast (GPtrArray *farray,
1194                          gpointer   data)
1195 {
1196   GRealPtrArray* array = (GRealPtrArray*) farray;
1197   guint i;
1198
1199   g_return_val_if_fail (array, FALSE);
1200
1201   for (i = 0; i < array->len; i += 1)
1202     {
1203       if (array->pdata[i] == data)
1204         {
1205           g_ptr_array_remove_index_fast (farray, i);
1206           return TRUE;
1207         }
1208     }
1209
1210   return FALSE;
1211 }
1212
1213 /**
1214  * g_ptr_array_add:
1215  * @array: a #GPtrArray.
1216  * @data: the pointer to add.
1217  *
1218  * Adds a pointer to the end of the pointer array. The array will grow
1219  * in size automatically if necessary.
1220  **/
1221 void
1222 g_ptr_array_add (GPtrArray *farray,
1223                  gpointer   data)
1224 {
1225   GRealPtrArray* array = (GRealPtrArray*) farray;
1226
1227   g_return_if_fail (array);
1228
1229   g_ptr_array_maybe_expand (array, 1);
1230
1231   array->pdata[array->len++] = data;
1232 }
1233
1234 /**
1235  * g_ptr_array_sort:
1236  * @array: a #GPtrArray.
1237  * @compare_func: comparison function.
1238  *
1239  * Sorts the array, using @compare_func which should be a qsort()-style
1240  * comparison function (returns less than zero for first arg is less
1241  * than second arg, zero for equal, greater than zero if irst arg is
1242  * greater than second arg).
1243  *
1244  * If two array elements compare equal, their order in the sorted array
1245  * is undefined. If you want equal elements to keep their order &#8211; i.e.
1246  * you want a stable sort &#8211; you can write a comparison function that,
1247  * if two elements would otherwise compare equal, compares them by
1248  * their addresses.
1249  *
1250  * <note><para>The comparison function for g_ptr_array_sort() doesn't
1251  * take the pointers from the array as arguments, it takes pointers to
1252  * the pointers in the array.</para></note>
1253  **/
1254 void
1255 g_ptr_array_sort (GPtrArray    *array,
1256                   GCompareFunc  compare_func)
1257 {
1258   g_return_if_fail (array != NULL);
1259
1260   qsort (array->pdata,
1261          array->len,
1262          sizeof (gpointer),
1263          compare_func);
1264 }
1265
1266 /**
1267  * g_ptr_array_sort_with_data:
1268  * @array: a #GPtrArray.
1269  * @compare_func: comparison function.
1270  * @user_data: data to pass to @compare_func.
1271  *
1272  * Like g_ptr_array_sort(), but the comparison function has an extra
1273  * user data argument.
1274  *
1275  * <note><para>The comparison function for g_ptr_array_sort_with_data()
1276  * doesn't take the pointers from the array as arguments, it takes
1277  * pointers to the pointers in the array.</para></note>
1278  **/
1279 void
1280 g_ptr_array_sort_with_data (GPtrArray        *array,
1281                             GCompareDataFunc  compare_func,
1282                             gpointer          user_data)
1283 {
1284   g_return_if_fail (array != NULL);
1285
1286   g_qsort_with_data (array->pdata,
1287                      array->len,
1288                      sizeof (gpointer),
1289                      compare_func,
1290                      user_data);
1291 }
1292
1293 /**
1294  * g_ptr_array_foreach:
1295  * @array: a #GPtrArray
1296  * @func: the function to call for each array element
1297  * @user_data: user data to pass to the function
1298  *
1299  * Calls a function for each element of a #GPtrArray.
1300  *
1301  * Since: 2.4
1302  **/
1303 void
1304 g_ptr_array_foreach (GPtrArray *array,
1305                      GFunc      func,
1306                      gpointer   user_data)
1307 {
1308   guint i;
1309
1310   g_return_if_fail (array);
1311
1312   for (i = 0; i < array->len; i++)
1313     (*func) (array->pdata[i], user_data);
1314 }
1315
1316 /**
1317  * SECTION:arrays_byte
1318  * @title: Byte Arrays
1319  * @short_description: arrays of bytes, which grow automatically as
1320  *                     elements are added
1321  *
1322  * #GByteArray is based on #GArray, to provide arrays of bytes which
1323  * grow automatically as elements are added.
1324  *
1325  * To create a new #GByteArray use g_byte_array_new().
1326  *
1327  * To add elements to a #GByteArray, use g_byte_array_append(), and
1328  * g_byte_array_prepend().
1329  *
1330  * To set the size of a #GByteArray, use g_byte_array_set_size().
1331  *
1332  * To free a #GByteArray, use g_byte_array_free().
1333  *
1334  * <example>
1335  *  <title>Using a #GByteArray</title>
1336  *  <programlisting>
1337  *   GByteArray *gbarray;
1338  *   gint i;
1339  *
1340  *   gbarray = g_byte_array_new (<!-- -->);
1341  *   for (i = 0; i &lt; 10000; i++)
1342  *     g_byte_array_append (gbarray, (guint8*) "abcd", 4);
1343  *
1344  *   for (i = 0; i &lt; 10000; i++)
1345  *     {
1346  *       g_assert (gbarray->data[4*i] == 'a');
1347  *       g_assert (gbarray->data[4*i+1] == 'b');
1348  *       g_assert (gbarray->data[4*i+2] == 'c');
1349  *       g_assert (gbarray->data[4*i+3] == 'd');
1350  *     }
1351  *
1352  *   g_byte_array_free (gbarray, TRUE);
1353  *  </programlisting>
1354  * </example>
1355  **/
1356
1357 /**
1358  * GByteArray:
1359  * @data: a pointer to the element data. The data may be moved as
1360  *        elements are added to the #GByteArray.
1361  * @len: the number of elements in the #GByteArray.
1362  *
1363  * The <structname>GByteArray</structname> struct allows access to the
1364  * public fields of a <structname>GByteArray</structname>.
1365  **/
1366
1367 /**
1368  * g_byte_array_new:
1369  * @Returns: the new #GByteArray.
1370  *
1371  * Creates a new #GByteArray with a reference count of 1.
1372  **/
1373 GByteArray* g_byte_array_new (void)
1374 {
1375   return (GByteArray*) g_array_sized_new (FALSE, FALSE, 1, 0);
1376 }
1377
1378 /**
1379  * g_byte_array_sized_new:
1380  * @reserved_size: number of bytes preallocated.
1381  * @Returns: the new #GByteArray.
1382  *
1383  * Creates a new #GByteArray with @reserved_size bytes preallocated.
1384  * This avoids frequent reallocation, if you are going to add many
1385  * bytes to the array. Note however that the size of the array is still
1386  * 0.
1387  **/
1388 GByteArray* g_byte_array_sized_new (guint reserved_size)
1389 {
1390   return (GByteArray*) g_array_sized_new (FALSE, FALSE, 1, reserved_size);
1391 }
1392
1393 /**
1394  * g_byte_array_free:
1395  * @array: a #GByteArray.
1396  * @free_segment: if %TRUE the actual byte data is freed as well.
1397  * @Returns: the element data if @free_segment is %FALSE, otherwise
1398  *           %NULL.  The element data should be freed using g_free().
1399  *
1400  * Frees the memory allocated by the #GByteArray. If @free_segment is
1401  * %TRUE it frees the actual byte data. If the reference count of
1402  * @array is greater than one, the #GByteArray wrapper is preserved but
1403  * the size of @array will be set to zero.
1404  **/
1405 guint8*     g_byte_array_free     (GByteArray *array,
1406                                    gboolean    free_segment)
1407 {
1408   return (guint8*) g_array_free ((GArray*) array, free_segment);
1409 }
1410
1411 /**
1412  * g_byte_array_ref:
1413  * @array: A #GByteArray.
1414  *
1415  * Atomically increments the reference count of @array by one. This
1416  * function is MT-safe and may be called from any thread.
1417  *
1418  * Returns: The passed in #GByteArray.
1419  *
1420  * Since: 2.22
1421  **/
1422 GByteArray *
1423 g_byte_array_ref (GByteArray *array)
1424 {
1425   return (GByteArray *) g_array_ref ((GArray *) array);
1426 }
1427
1428 /**
1429  * g_byte_array_unref:
1430  * @array: A #GByteArray.
1431  *
1432  * Atomically decrements the reference count of @array by one. If the
1433  * reference count drops to 0, all memory allocated by the array is
1434  * released. This function is MT-safe and may be called from any
1435  * thread.
1436  *
1437  * Since: 2.22
1438  **/
1439 void
1440 g_byte_array_unref (GByteArray *array)
1441 {
1442   g_array_unref ((GArray *) array);
1443 }
1444
1445 /**
1446  * g_byte_array_append:
1447  * @array: a #GByteArray.
1448  * @data: the byte data to be added.
1449  * @len: the number of bytes to add.
1450  * @Returns: the #GByteArray.
1451  *
1452  * Adds the given bytes to the end of the #GByteArray. The array will
1453  * grow in size automatically if necessary.
1454  **/
1455 GByteArray* g_byte_array_append   (GByteArray   *array,
1456                                    const guint8 *data,
1457                                    guint         len)
1458 {
1459   g_array_append_vals ((GArray*) array, (guint8*)data, len);
1460
1461   return array;
1462 }
1463
1464 /**
1465  * g_byte_array_prepend:
1466  * @array: a #GByteArray.
1467  * @data: the byte data to be added.
1468  * @len: the number of bytes to add.
1469  * @Returns: the #GByteArray.
1470  *
1471  * Adds the given data to the start of the #GByteArray. The array will
1472  * grow in size automatically if necessary.
1473  **/
1474 GByteArray* g_byte_array_prepend  (GByteArray   *array,
1475                                    const guint8 *data,
1476                                    guint         len)
1477 {
1478   g_array_prepend_vals ((GArray*) array, (guint8*)data, len);
1479
1480   return array;
1481 }
1482
1483 /**
1484  * g_byte_array_set_size:
1485  * @array: a #GByteArray.
1486  * @length: the new size of the #GByteArray.
1487  * @Returns: the #GByteArray.
1488  *
1489  * Sets the size of the #GByteArray, expanding it if necessary.
1490  **/
1491 GByteArray* g_byte_array_set_size (GByteArray *array,
1492                                    guint       length)
1493 {
1494   g_array_set_size ((GArray*) array, length);
1495
1496   return array;
1497 }
1498
1499 /**
1500  * g_byte_array_remove_index:
1501  * @array: a #GByteArray.
1502  * @index_: the index of the byte to remove.
1503  * @Returns: the #GByteArray.
1504  *
1505  * Removes the byte at the given index from a #GByteArray. The
1506  * following bytes are moved down one place.
1507  **/
1508 GByteArray* g_byte_array_remove_index (GByteArray *array,
1509                                        guint       index_)
1510 {
1511   g_array_remove_index ((GArray*) array, index_);
1512
1513   return array;
1514 }
1515
1516 /**
1517  * g_byte_array_remove_index_fast:
1518  * @array: a #GByteArray.
1519  * @index_: the index of the byte to remove.
1520  * @Returns: the #GByteArray.
1521  *
1522  * Removes the byte at the given index from a #GByteArray. The last
1523  * element in the array is used to fill in the space, so this function
1524  * does not preserve the order of the #GByteArray. But it is faster
1525  * than g_byte_array_remove_index().
1526  **/
1527 GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
1528                                             guint       index_)
1529 {
1530   g_array_remove_index_fast ((GArray*) array, index_);
1531
1532   return array;
1533 }
1534
1535 /**
1536  * g_byte_array_remove_range:
1537  * @array: a @GByteArray.
1538  * @index_: the index of the first byte to remove.
1539  * @length: the number of bytes to remove.
1540  * @Returns: the #GByteArray.
1541  *
1542  * Removes the given number of bytes starting at the given index from a
1543  * #GByteArray.  The following elements are moved to close the gap.
1544  *
1545  * Since: 2.4
1546  **/
1547 GByteArray*
1548 g_byte_array_remove_range (GByteArray *array,
1549                            guint       index_,
1550                            guint       length)
1551 {
1552   g_return_val_if_fail (array, NULL);
1553   g_return_val_if_fail (index_ < array->len, NULL);
1554   g_return_val_if_fail (index_ + length <= array->len, NULL);
1555
1556   return (GByteArray *)g_array_remove_range ((GArray*) array, index_, length);
1557 }
1558
1559 /**
1560  * g_byte_array_sort:
1561  * @array: a #GByteArray.
1562  * @compare_func: comparison function.
1563  *
1564  * Sorts a byte array, using @compare_func which should be a
1565  * qsort()-style comparison function (returns less than zero for first
1566  * arg is less than second arg, zero for equal, greater than zero if
1567  * first arg is greater than second arg).
1568  *
1569  * If two array elements compare equal, their order in the sorted array
1570  * is undefined. If you want equal elements to keep their order &#8211; i.e.
1571  * you want a stable sort &#8211; you can write a comparison function that,
1572  * if two elements would otherwise compare equal, compares them by
1573  * their addresses.
1574  **/
1575 void
1576 g_byte_array_sort (GByteArray   *array,
1577                    GCompareFunc  compare_func)
1578 {
1579   g_array_sort ((GArray *) array, compare_func);
1580 }
1581
1582 /**
1583  * g_byte_array_sort_with_data:
1584  * @array: a #GByteArray.
1585  * @compare_func: comparison function.
1586  * @user_data: data to pass to @compare_func.
1587  *
1588  * Like g_byte_array_sort(), but the comparison function takes an extra
1589  * user data argument.
1590  **/
1591 void
1592 g_byte_array_sort_with_data (GByteArray       *array,
1593                              GCompareDataFunc  compare_func,
1594                              gpointer          user_data)
1595 {
1596   g_array_sort_with_data ((GArray *) array, compare_func, user_data);
1597 }