land.array

Remove the last element in the array and return it. Only the last element in an array can be removed. To remove another element, you could replace it with the last (land_array_replace_nth) and remove the last with this function.

land_array_remove

Parameters: LandArray * self, int i

Returns: void*

Return item at position i and replace it with the last item, shortening the array by one.

If i is the last item this is identical to land_array_pop.

land_array_add_data

Parameters: LandArray * (* array), void * data

deprecated Use land_array_add in new code, as this function might be removed in a future version.

Given a pointer to a (possibly NULL valued) array pointer, create a new node
with the given data, and add to the (possibly modified) array.

land_array_find

Parameters: LandArray * self, void * data

Returns: int

Searches the array for the given data. If they are contained, return the first index i so that land_array_get_nth(array, i) == data. If the data cannot be found, -1 is returned.

land_array_get_nth

Parameters: LandArray const * array, int i

Returns: void*

land_array_get_or_none

Parameters: LandArray const * array, int i

Returns: void*

land_array_get

Parameters: LandArray const * array, int i

Returns: void*

land_array_is_empty

Parameters: LandArray const * array

Returns: bool

land_array_replace_nth

Parameters: LandArray * array, int i, void * data

Returns: void*

Replace the array entry at the given index, and return the previous contents.

land_array_replace_or_resize

Parameters: LandArray * array, int i, void * data

Returns: void*

Replaces the entry at i and returns the previous data. If i is outside the size of the array, resize it.

land_array_get_last

Parameters: LandArray * array

Returns: void*

land_array_destroy

Parameters: LandArray * self

Destroys an array. This does not destroy any of the data put into it - loop through the array before and destroy the data if there are no other references to them.

land_array_destroy_with_strings

Parameters: LandArray * self

land_array_destroy_with_free

Parameters: LandArray * self

Like [land_array_destroy] but also calls land_free on every element.

land_array_sort

Parameters: LandArray * self, int(* cmpfnc)(void const * a, void const * b)

Sorts the entries in the array. The given callback function gets passed two direct pointers to two array elements, and expects a return value determining the order: < 0: a is before b = 0: order is arbitrary > 0: a is after b

land_array_sort_alphabetical

Parameters: LandArray * self

Expects all array members to be strings and sorts alphabetically.

land_array_count

Parameters: LandArray const * self

Returns: int

land_array_for_each

Parameters: LandArray * self, int(* cb)(void * item, void * data), void * data

Returns: int

Call the given callback for each array element. If the callback returns anything but 0, the iteration is stopped. The return value is the number of times the callback was called. The data argument simply is passed as-is to the callback.