basic queue library

Collaboration diagram for basic queue library:

Data Structures
struct	a_que
	instance structure for basic queue More...

Macros
#define	A_QUE_FORE_(T, ctx)
#define	A_QUE_BACK_(T, ctx)
#define	A_QUE_FORE(T, ctx)
#define	A_QUE_BACK(T, ctx)
#define	A_QUE_AT(T, ctx, idx)
#define	A_QUE_PUSH_SORT(T, ctx, key, cmp)
#define	A_QUE_PUSH_FORE(T, ctx)
#define	A_QUE_PUSH_BACK(T, ctx)
#define	A_QUE_PULL_FORE(T, ctx)
#define	A_QUE_PULL_BACK(T, ctx)
#define	A_QUE_INSERT(T, ctx, idx)
#define	A_QUE_REMOVE(T, ctx, idx)
#define	a_que_foreach(T, S, it, ctx)
	iterate over a queue
#define	A_QUE_FOREACH(T, it, at, ctx)
#define	a_que_foreach_reverse(T, S, it, ctx)
	iterate over a queue in reverse
#define	A_QUE_FOREACH_REVERSE(T, it, at, ctx)

Typedefs
typedef struct a_que	a_que
	instance structure for basic queue

Functions
a_size	a_que_siz (a_que const *ctx)
	access size of a element for a pointer to queue structure
a_size	a_que_num (a_que const *ctx)
	access number of element for a pointer to queue structure
void *	a_que_fore_ (a_que const *ctx)
	access foremost element for a pointer to queue structure
void *	a_que_back_ (a_que const *ctx)
	access backmost element for a pointer to queue structure
void *	a_que_fore (a_que const *ctx)
	access foremost element for a pointer to queue structure
void *	a_que_back (a_que const *ctx)
	access backmost element for a pointer to queue structure
void	a_que_swap_ (void *lhs, void *rhs)
	swap elements lhs and rhs for a pointer to queue structure
a_que *	a_que_new (a_size size)
	allocate a pointer to queue structure from memory
void	a_que_die (a_que *ctx, void(*dtor)(void *))
	deallocate a pointer to queue structure
void	a_que_ctor (a_que *ctx, a_size size)
	constructor for queue structure
void	a_que_dtor (a_que *ctx, void(*dtor)(void *))
	destructor for queue structure
void	a_que_swap (a_que *lhs, a_que *rhs)
	initialize a pointer to queue structure by moving
int	a_que_drop (a_que *ctx, void(*dtor)(void *))
	drop all the elements for a pointer to queue structure
int	a_que_setz (a_que *ctx, a_size siz, void(*dtor)(void *))
	set size of a element for a pointer to queue structure
void *	a_que_at (a_que const *ctx, a_diff idx)
	access specified element for a pointer to queue structure
void	a_que_sort_fore (a_que const *ctx, int(*cmp)(void const *, void const *))
	insert sort foremost element for a pointer to queue structure
void	a_que_sort_back (a_que const *ctx, int(*cmp)(void const *, void const *))
	insert sort backmost element for a pointer to queue structure
void *	a_que_push_sort (a_que *ctx, void const *key, int(*cmp)(void const *, void const *))
	push an element into the queue and sort it
void *	a_que_push_fore (a_que *ctx)
	push an element into the queue forward
void *	a_que_push_back (a_que *ctx)
	push an element into the queue backward
void *	a_que_pull_fore (a_que *ctx)
	pull an element from the queue forward
void *	a_que_pull_back (a_que *ctx)
	pull an element from the queue backward
void *	a_que_insert (a_que *ctx, a_size idx)
	insert an element into the queue
void *	a_que_remove (a_que *ctx, a_size idx)
	remove an element from the queue

Detailed Description

Macro Definition Documentation

A_QUE_AT

#define A_QUE_AT	(		T,
			ctx,
			idx )

Value:

a_cast_s(T *, a_que_at(ctx, idx))

A_QUE_BACK

#define A_QUE_BACK	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_back(ctx))

A_QUE_BACK_

#define A_QUE_BACK_	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_back_(ctx))

A_QUE_FORE

#define A_QUE_FORE	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_fore(ctx))

A_QUE_FORE_

#define A_QUE_FORE_	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_fore_(ctx))

A_QUE_FOREACH

#define A_QUE_FOREACH	(		T,
			it,
			at,
			ctx )

Value:

    for ((void)(it = a_cast_r(T, (ctx)->head_.next)),            \
         at = a_cast_r(T, a_list_(*, it)->next);                 \
         a_list_(*, it) != &(ctx)->head_                         \
             ? ((void)(it = a_cast_r(T, a_list_(*, it) + 1)), 1) \
             : (0);                                              \
         it = at, at = a_cast_r(T, a_list_(*, it)->next))

a_que_foreach

#define a_que_foreach	(		T,
			S,
			it,
			ctx )

Value:

    for (T S it = a_cast_r(T S, (ctx)->head_.next),                \
             S it##_ = a_cast_r(T S, a_list_(*, it)->next);        \
         a_list_(*, it) != &(ctx)->head_                           \
             ? ((void)(it = a_cast_r(T S, a_list_(*, it) + 1)), 1) \
             : (0);                                                \
         it = it##_, it##_ = a_cast_r(T S, a_list_(*, it)->next))

iterate over a queue

a_que_foreach(T, *, it, ctx)
{
    assert(a_que_siz(ctx) >= sizeof(*it));
}

Parameters

T	the prefix of the element type
S	the suffix of the element type
it	the &a_que to use as a loop counter
ctx	points to an instance of queue structure

A_QUE_FOREACH_REVERSE

#define A_QUE_FOREACH_REVERSE	(		T,
			it,
			at,
			ctx )

Value:

    for ((void)(it = a_cast_r(T, (ctx)->head_.prev)),            \
         at = a_cast_r(T, a_list_(*, it)->prev);                 \
         a_list_(*, it) != &(ctx)->head_                         \
             ? ((void)(it = a_cast_r(T, a_list_(*, it) + 1)), 1) \
             : (0);                                              \
         it = at, at = a_cast_r(T, a_list_(*, it)->prev))

a_que_foreach_reverse

#define a_que_foreach_reverse	(		T,
			S,
			it,
			ctx )

Value:

    for (T S it = a_cast_r(T S, (ctx)->head_.prev),                \
             S it##_ = a_cast_r(T S, a_list_(*, it)->prev);        \
         a_list_(*, it) != &(ctx)->head_                           \
             ? ((void)(it = a_cast_r(T S, a_list_(*, it) + 1)), 1) \
             : (0);                                                \
         it = it##_, it##_ = a_cast_r(T S, a_list_(*, it)->prev))

iterate over a queue in reverse

a_que_foreach_reverse(T, *, it, ctx)
{
    assert(a_que_siz(ctx) >= sizeof(*it));
}

Parameters

T	the prefix of the element type
S	the suffix of the element type
it	the &a_que to use as a loop counter
ctx	points to an instance of queue structure

A_QUE_INSERT

#define A_QUE_INSERT	(		T,
			ctx,
			idx )

Value:

a_cast_s(T *, a_que_insert(ctx, idx))

A_QUE_PULL_BACK

#define A_QUE_PULL_BACK	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_pull_back(ctx))

A_QUE_PULL_FORE

#define A_QUE_PULL_FORE	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_pull_fore(ctx))

A_QUE_PUSH_BACK

#define A_QUE_PUSH_BACK	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_push_back(ctx))

A_QUE_PUSH_FORE

#define A_QUE_PUSH_FORE	(		T,
			ctx )

Value:

a_cast_s(T *, a_que_push_fore(ctx))

A_QUE_PUSH_SORT

#define A_QUE_PUSH_SORT	(		T,
			ctx,
			key,
			cmp )

Value:

a_cast_s(T *, a_que_push_sort(ctx, key, cmp))

A_QUE_REMOVE

#define A_QUE_REMOVE	(		T,
			ctx,
			idx )

Value:

a_cast_s(T *, a_que_remove(ctx, idx))

Function Documentation

a_que_at()

void * a_que_at	(	a_que const *	ctx,
		a_diff	idx )

access specified element for a pointer to queue structure

Parameters

[in]	ctx	points to an instance of queue structure
[in]	idx	index of element, 0 ~ n-1, -n ~ -1

Returns

element pointer

Return values

0	out of bounds

a_que_back()

void * a_que_back

(

a_que const *

ctx

)

access backmost element for a pointer to queue structure

Parameters

[in]

ctx

points to an instance of queue structure

Returns

element pointer

Return values

0	empty queue

a_que_back_()

void * a_que_back_

(

a_que const *

ctx

)

access backmost element for a pointer to queue structure

Parameters

[in]

ctx

points to an instance of queue structure

Note

should check if queue is empty

Returns

element pointer

a_que_ctor()

void a_que_ctor	(	a_que *	ctx,
		a_size	size )

constructor for queue structure

Parameters

[in]	ctx	points to an instance of queue structure
[in]	size	size of element

a_que_die()

void a_que_die	(	a_que *	ctx,
		void(*	dtor )(void *) )

deallocate a pointer to queue structure

Parameters

[in]	ctx	points to an instance of queue structure
[in]	dtor	element destructor

a_que_drop()

int a_que_drop	(	a_que *	ctx,
		void(*	dtor )(void *) )

drop all the elements for a pointer to queue structure

Parameters

[in]	ctx	points to an instance of queue structure
[in]	dtor	current element destructor

Returns

error code value

Return values

0

success

a_que_dtor()

void a_que_dtor	(	a_que *	ctx,
		void(*	dtor )(void *) )

destructor for queue structure

Parameters

[in]	ctx	points to an instance of queue structure
[in]	dtor	element destructor

a_que_fore()

void * a_que_fore

(

a_que const *

ctx

)

access foremost element for a pointer to queue structure

Parameters

[in]

ctx

points to an instance of queue structure

Returns

element pointer

Return values

0	empty queue

a_que_fore_()

void * a_que_fore_

(

a_que const *

ctx

)

access foremost element for a pointer to queue structure

Parameters

[in]

ctx

points to an instance of queue structure

Note

should check if queue is empty

Returns

element pointer

a_que_insert()

void * a_que_insert	(	a_que *	ctx,
		a_size	idx )

insert an element into the queue

Parameters

[in]	ctx	points to an instance of queue structure
[in]	idx	index of element in this queue 0 a_que_push_fore n a_que_push_back

Returns

element pointer

Return values

0

failure

a_que_new()

a_que * a_que_new

(

a_size

size

)

allocate a pointer to queue structure from memory

Parameters

[in]

size

size of element

a_que_num()

a_size a_que_num

(

a_que const *

ctx

)

access number of element for a pointer to queue structure

Parameters

[in]

ctx

points to an instance of queue structure

a_que_pull_back()

void * a_que_pull_back

(

a_que *

ctx

)

pull an element from the queue backward

Parameters

[in]

ctx

points to an instance of queue structure

Returns

element pointer

Return values

0

failure

a_que_pull_fore()

void * a_que_pull_fore

(

a_que *

ctx

)

pull an element from the queue forward

Parameters

[in]

ctx

points to an instance of queue structure

Returns

element pointer

Return values

0

failure

a_que_push_back()

void * a_que_push_back

(

a_que *

ctx

)

push an element into the queue backward

Parameters

[in]

ctx

points to an instance of queue structure

Returns

element pointer

Return values

0

failure

a_que_push_fore()

void * a_que_push_fore

(

a_que *

ctx

)

push an element into the queue forward

Parameters

[in]

ctx

points to an instance of queue structure

Returns

element pointer

Return values

0

failure

a_que_push_sort()

void * a_que_push_sort	(	a_que *	ctx,
		void const *	key,
		int(*	cmp )(void const *, void const *) )

push an element into the queue and sort it

Parameters

[in]	ctx	points to an instance of queue structure
[in]	key	the key on the right for insertion sort
[in]	cmp	a function that compares two elements cmp(lhs,rhs)==0 *lhs is equivalent to *rhs cmp(lhs,rhs)<0 *lhs goes before *rhs cmp(lhs,rhs)>0 *lhs goes after *rhs

Returns

element pointer

Return values

0

failure

a_que_remove()

void * a_que_remove	(	a_que *	ctx,
		a_size	idx )

remove an element from the queue

Parameters

[in]	ctx	points to an instance of queue structure
[in]	idx	index of element in this queue 0 a_que_pull_fore n a_que_pull_back

Returns

element pointer

Return values

0

failure

a_que_setz()

int a_que_setz	(	a_que *	ctx,
		a_size	siz,
		void(*	dtor )(void *) )

set size of a element for a pointer to queue structure

Parameters

[in]	ctx	points to an instance of queue structure
[in]	siz	the size of the new element
[in]	dtor	previous element destructor

Returns

error code value

Return values

0

success

a_que_siz()

a_size a_que_siz

(

a_que const *

ctx

)

access size of a element for a pointer to queue structure

Parameters

[in]

ctx

points to an instance of queue structure

a_que_sort_back()

void a_que_sort_back	(	a_que const *	ctx,
		int(*	cmp )(void const *, void const *) )

insert sort backmost element for a pointer to queue structure

T *obj = A_QUE_PUSH_BACK(T, ctx);
if (obj)
{
    CTOR(obj);
    INIT(obj);
    a_que_sort_back(ctx, cmp);
}

Parameters

[in]	ctx	points to an instance of queue structure
[in]	cmp	a function that compares two elements cmp(lhs,rhs)==0 *lhs is equivalent to *rhs cmp(lhs,rhs)<0 *lhs goes before *rhs cmp(lhs,rhs)>0 *lhs goes after *rhs

a_que_sort_fore()

void a_que_sort_fore	(	a_que const *	ctx,
		int(*	cmp )(void const *, void const *) )

insert sort foremost element for a pointer to queue structure

T *obj = A_QUE_PUSH_FORE(T, ctx);
if (obj)
{
    CTOR(obj);
    INIT(obj);
    a_que_sort_fore(ctx, cmp);
}

Parameters

[in]	ctx	points to an instance of queue structure
[in]	cmp	a function that compares two elements cmp(lhs,rhs)==0 *lhs is equivalent to *rhs cmp(lhs,rhs)<0 *lhs goes before *rhs cmp(lhs,rhs)>0 *lhs goes after *rhs

a_que_swap()

void a_que_swap	(	a_que *	lhs,
		a_que *	rhs )

initialize a pointer to queue structure by moving

Parameters

[in]	lhs	points to an instance of queue structure
[in]	rhs	points to an instance of queue structure

a_que_swap_()

void a_que_swap_	(	void *	lhs,
		void *	rhs )

swap elements lhs and rhs for a pointer to queue structure

Parameters

[in]	lhs	element pointer on the left
[in]	rhs	element pointer on the right