Enumerator objects allow to walk through a set of elements. More...

#include "gate/gate_core_api.h"
#include "gate/gatetypes.h"

Data Structures
struct	gate_enumerator_class
	Enumerator data type that stores the enumeration state. More...

Typedefs
typedef struct gate_enumerator_class	gate_enumerator_t
	Enumerator data type that stores the enumeration state.

Functions
GATE_CORE_API gate_bool_t	gate_enumerator_valid (gate_enumerator_t const *enumerator)
	Returns if the enumerator currently points to a valid item.

GATE_CORE_API gate_bool_t	gate_enumerator_next (gate_enumerator_t *enumerator)
	Moves the iterator to the next following item.

GATE_CORE_API void const *	gate_enumerator_get (gate_enumerator_t const *enumerator)
	Returns a pointer to the current element.

GATE_CORE_API void const *	gate_enumerator_next_item (gate_enumerator_t *enumerator)
	Moves the iterator to the next following item and returns a pointer to it.

GATE_CORE_API gate_enumerator_t *	gate_enumerator_for_array (gate_enumerator_t enumerator, void const begin, gate_size_t item_size, gate_size_t item_count)
	Creates an enumerator for a native C sequence array.

Detailed Description

Enumerator objects allow to walk through a set of elements.

Function Documentation

GATE_CORE_API gate_bool_t gate_enumerator_valid ( gate_enumerator_t const * enumerator )

Returns if the enumerator currently points to a valid item.

Parameters

[in] enumerator pointer to enumerator object

Returns: returns TRUE if gate_enumerator_get() would return a valid item, or FALSE if the end of the set was reached.

GATE_CORE_API gate_bool_t gate_enumerator_next ( gate_enumerator_t * enumerator )

Moves the iterator to the next following item.

Parameters

[in] enumerator pointer to enumerator object

Returns: returns TRUE if the functions was successful and the next element can be retrieved, or FALSE if the end of the set was reached.

GATE_CORE_API void const * gate_enumerator_get ( gate_enumerator_t const * enumerator )

Returns a pointer to the current element.

Parameters

[in] enumerator pointer to enumerator object

Returns: returns a pointer if the current element is valid, otherwise the return value is unspecified (can be anything); use gate_enumerator_valid() to verify the state

GATE_CORE_API void const * gate_enumerator_next_item ( gate_enumerator_t * enumerator )

Moves the iterator to the next following item and returns a pointer to it.

Parameters

[in] enumerator pointer to enumerator object

GATE_CORE_API gate_enumerator_t * gate_enumerator_for_array	(	gate_enumerator_t *	enumerator,
		void const *	begin,
		gate_size_t	item_size,
		gate_size_t	item_count )

Creates an enumerator for a native C sequence array.

Parameters

enumerator	pointer to enumerator object
begin	pointer to the first element in the C sequence array
item_size	size of on item in the array in bytes (cannot be 0)
item_count	amount of items in the array (can be 0)