/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = glib-Arrays.html
 * outPack = glib
 * outFile = ArrayG
 * strct   = GArray
 * realStrct=
 * ctorStrct=
 * clss    = ArrayG
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- g_array_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.Str
 * structWrap:
 * 	- GArray* -> ArrayG
 * module aliases:
 * local aliases:
 * overrides:
 */

module glib.ArrayG;

public  import gtkc.glibtypes;

private import gtkc.glib;
private import glib.ConstructionException;

private import glib.Str;



/**
 * 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().
 *
 * $(DDOC_COMMENT example)
 */
public class ArrayG
{
	
	/** the main Gtk struct */
	protected GArray* gArray;
	
	
	/** Get the main Gtk struct */
	public GArray* getArrayGStruct()
	{
		return gArray;
	}
	
	
	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)gArray;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GArray* gArray)
	{
		this.gArray = gArray;
	}
	
	/**
	 */
	
	/**
	 * Creates a new GArray with a reference count of 1.
	 * Params:
	 * zeroTerminated = TRUE if the array should have an extra element at
	 * the end which is set to 0.
	 * clear = TRUE if GArray elements should be automatically cleared
	 * to 0 when they are allocated.
	 * elementSize = the size of each element in bytes.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this (int zeroTerminated, int clear, uint elementSize)
	{
		// GArray * g_array_new (gboolean zero_terminated,  gboolean clear_,  guint element_size);
		auto p = g_array_new(zeroTerminated, clear, elementSize);
		if(p is null)
		{
			throw new ConstructionException("null returned by g_array_new(zeroTerminated, clear, elementSize)");
		}
		this(cast(GArray*) p);
	}
	
	/**
	 * 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.
	 * Params:
	 * zeroTerminated = TRUE if the array should have an extra element at
	 * the end with all bits cleared.
	 * clear = TRUE if all bits in the array should be cleared to 0 on
	 * allocation.
	 * elementSize = size of each element in the array.
	 * reservedSize = number of elements preallocated.
	 * Returns: the new GArray.
	 */
	public static ArrayG sizedNew(int zeroTerminated, int clear, uint elementSize, uint reservedSize)
	{
		// GArray * g_array_sized_new (gboolean zero_terminated,  gboolean clear_,  guint element_size,  guint reserved_size);
		auto p = g_array_sized_new(zeroTerminated, clear, elementSize, reservedSize);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * Atomically increments the reference count of array by one. This
	 * function is MT-safe and may be called from any thread.
	 * Since 2.22
	 * Returns: The passed in GArray.
	 */
	public ArrayG doref()
	{
		// GArray * g_array_ref (GArray *array);
		auto p = g_array_ref(gArray);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * 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
	 */
	public void unref()
	{
		// void g_array_unref (GArray *array);
		g_array_unref(gArray);
	}
	
	/**
	 * Gets the size of the elements in array.
	 * Since 2.22
	 * Returns: Size of each element, in bytes.
	 */
	public uint getElementSize()
	{
		// guint g_array_get_element_size (GArray *array);
		return g_array_get_element_size(gArray);
	}
	
	/**
	 * Adds len elements onto the end of the array.
	 * Params:
	 * data = a pointer to the elements to append to the end of the array.
	 * len = the number of elements to append.
	 * Returns: the GArray.
	 */
	public ArrayG appendVals(void* data, uint len)
	{
		// GArray * g_array_append_vals (GArray *array,  gconstpointer data,  guint len);
		auto p = g_array_append_vals(gArray, data, len);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * 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.
	 * Params:
	 * data = a pointer to the elements to prepend to the start of the
	 * array.
	 * len = the number of elements to prepend.
	 * Returns: the GArray.
	 */
	public ArrayG prependVals(void* data, uint len)
	{
		// GArray * g_array_prepend_vals (GArray *array,  gconstpointer data,  guint len);
		auto p = g_array_prepend_vals(gArray, data, len);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * Inserts len elements into a GArray at the given index.
	 * Params:
	 * index = the index to place the elements at.
	 * data = a pointer to the elements to insert.
	 * len = the number of elements to insert.
	 * Returns: the GArray.
	 */
	public ArrayG insertVals(uint index, void* data, uint len)
	{
		// GArray * g_array_insert_vals (GArray *array,  guint index_,  gconstpointer data,  guint len);
		auto p = g_array_insert_vals(gArray, index, data, len);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * Removes the element at the given index from a GArray. The following
	 * elements are moved down one place.
	 * Params:
	 * index = the index of the element to remove.
	 * Returns: the GArray.
	 */
	public ArrayG removeIndex(uint index)
	{
		// GArray * g_array_remove_index (GArray *array,  guint index_);
		auto p = g_array_remove_index(gArray, index);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * 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().
	 * Params:
	 * index = the index of the element to remove.
	 * Returns: the GArray.
	 */
	public ArrayG removeIndexFast(uint index)
	{
		// GArray * g_array_remove_index_fast (GArray *array,  guint index_);
		auto p = g_array_remove_index_fast(gArray, index);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * 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
	 * Params:
	 * index = the index of the first element to remove.
	 * length = the number of elements to remove.
	 * Returns: the GArray.
	 */
	public ArrayG removeRange(uint index, uint length)
	{
		// GArray * g_array_remove_range (GArray *array,  guint index_,  guint length);
		auto p = g_array_remove_range(gArray, index, length);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * 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).
	 * This is guaranteed to be a stable sort since version 2.32.
	 * Params:
	 * compareFunc = comparison function.
	 */
	public void sort(GCompareFunc compareFunc)
	{
		// void g_array_sort (GArray *array,  GCompareFunc compare_func);
		g_array_sort(gArray, compareFunc);
	}
	
	/**
	 * Like g_array_sort(), but the comparison function receives an extra
	 * user data argument.
	 * This is guaranteed to be a stable sort since version 2.32.
	 * There used to be a comment here about making the sort stable by
	 * using the addresses of the elements in the comparison function.
	 * This did not actually work, so any such code should be removed.
	 * Params:
	 * compareFunc = comparison function.
	 * userData = data to pass to compare_func.
	 */
	public void sortWithData(GCompareDataFunc compareFunc, void* userData)
	{
		// void g_array_sort_with_data (GArray *array,  GCompareDataFunc compare_func,  gpointer user_data);
		g_array_sort_with_data(gArray, compareFunc, userData);
	}
	
	/**
	 * 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.
	 * Params:
	 * length = the new size of the GArray.
	 * Returns: the GArray.
	 */
	public ArrayG setSize(uint length)
	{
		// GArray * g_array_set_size (GArray *array,  guint length);
		auto p = g_array_set_size(gArray, length);
		
		if(p is null)
		{
			return null;
		}
		
		return new ArrayG(cast(GArray*) p);
	}
	
	/**
	 * Sets a function to clear an element of array.
	 * The clear_func will be called when an element in the array
	 * data segment is removed and when the array is freed and data
	 * segment is deallocated as well.
	 * Note that in contrast with other uses of GDestroyNotify
	 * functions, clear_func is expected to clear the contents of
	 * the array element it is given, but not free the element itself.
	 * Since 2.32
	 * Params:
	 * clearFunc = a function to clear an element of array
	 */
	public void setClearFunc(GDestroyNotify clearFunc)
	{
		// void g_array_set_clear_func (GArray *array,  GDestroyNotify clear_func);
		g_array_set_clear_func(gArray, clearFunc);
	}
	
	/**
	 * 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.
	 * Params:
	 * freeSegment = if TRUE the actual element data is freed as well.
	 * Returns: the element data if free_segment is FALSE, otherwise NULL. The element data should be freed using g_free().
	 */
	public string free(int freeSegment)
	{
		// gchar * g_array_free (GArray *array,  gboolean free_segment);
		return Str.toString(g_array_free(gArray, freeSegment));
	}
}