ArrayG

Description Arrays are similar to standard C arrays, except that they grow automatically as elements are added. Array elements can be of any size (though all elements of one array are the same size), and the array can be automatically cleared to '0's and zero-terminated. To create a new array use g_array_new(). To add elements to an array, use g_array_append_val(), g_array_append_vals(), g_array_prepend_val(), and g_array_prepend_vals(). To access an element of an array, use g_array_index(). To set the size of an array, use g_array_set_size(). To free an array, use g_array_free().

class ArrayG {

protected

GArray* gArray;

GArray* getArrayGStruct();

void* getStruct();

this(GArray* gArray);

this(int zeroTerminated, int clear, uint elementSize);

static ArrayG sizedNew(int zeroTerminated, int clear, uint elementSize, uint reservedSize);

ArrayG doref();

void unref();

uint getElementSize();

ArrayG appendVals(void* data, uint len);

ArrayG prependVals(void* data, uint len);

ArrayG insertVals(uint index, void* data, uint len);

ArrayG removeIndex(uint index);

ArrayG removeIndexFast(uint index);

ArrayG removeRange(uint index, uint length);

void sort(GCompareFunc compareFunc);

void sortWithData(GCompareDataFunc compareFunc, void* userData);

ArrayG setSize(uint length);

string free(int freeSegment);

}

Constructors

this this(GArray* gArray): Sets our main struct and passes it to the parent class
this this(int zeroTerminated, int clear, uint elementSize): Creates a new GArray with a reference count of 1.

Members

Functions

appendVals ArrayG appendVals(void* data, uint len): Adds len elements onto the end of the array.
doref ArrayG doref(): Atomically increments the reference count of array by one. This function is MT-safe and may be called from any thread. Since 2.22
free string free(int freeSegment): Frees the memory allocated for the GArray. If free_segment is TRUE it frees the memory block holding the elements as well and also each element if array has a element_free_func set. Pass FALSE if you want to free the GArray wrapper but preserve the underlying array for use elsewhere. If the reference count of array is greater than one, the GArray wrapper is preserved but the size of array will be set to zero. Note If array elements contain dynamically-allocated memory, they should be freed separately.
getArrayGStruct GArray* getArrayGStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getElementSize uint getElementSize(): Gets the size of the elements in array. Since 2.22
getStruct void* getStruct(): the main Gtk struct as a void*
insertVals ArrayG insertVals(uint index, void* data, uint len): Inserts len elements into a GArray at the given index.
prependVals ArrayG prependVals(void* data, uint len): Adds len elements onto the start of the array. This operation is slower than g_array_append_vals() since the existing elements in the array have to be moved to make space for the new elements.
removeIndex ArrayG removeIndex(uint index): Removes the element at the given index from a GArray. The following elements are moved down one place.
removeIndexFast ArrayG removeIndexFast(uint index): Removes the element at the given index from a GArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the GArray. But it is faster than g_array_remove_index().
removeRange ArrayG removeRange(uint index, uint length): Removes the given number of elements starting at the given index from a GArray. The following elements are moved to close the gap. Since 2.4
setSize ArrayG setSize(uint length): Sets the size of the array, expanding it if necessary. If the array was created with clear_ set to TRUE, the new elements are set to 0.
sort void sort(GCompareFunc compareFunc): Sorts a GArray using compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater zero if first arg is greater than second arg). If two array elements compare equal, their order in the sorted array is undefined.
sortWithData void sortWithData(GCompareDataFunc compareFunc, void* userData): Like g_array_sort(), but the comparison function receives an extra user data argument.
unref void unref(): Atomically decrements the reference count of array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is MT-safe and may be called from any thread. Since 2.22

Static functions

sizedNew ArrayG sizedNew(int zeroTerminated, int clear, uint elementSize, uint reservedSize): Creates a new GArray with reserved_size elements preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many elements to the array. Note however that the size of the array is still 0.

Variables

gArray GArray* gArray;: the main Gtk struct