tkqueue.h File Reference

#include "types/err.h"
#include "types/tkqueue.h"

Include dependency graph for tkqueue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	QUEUE_LENGTH_INCREMENT   32

Functions
void	tkqueue_init (tkqueue_t *queue, unsigned int initial_size)
	Initializes the token queue.
void	tkqueue_close (tkqueue_t *queue)
	Close the given queue.
void	tkqueue_add (tkqueue_t *queue, token_t *token)
	Add a value to the token queue.
token_t *	tkqueue_get (tkqueue_t *queue)
	Get the current value from the queue and increment the position for the next value.
token_t *	tkqueue_peek (const tkqueue_t *queue)
	Get the current value from the queue without increment the queue position.
int	tkqueue_isempty (const tkqueue_t *queue)
	Check if the given queue is empty.

Macro Definition Documentation

QUEUE_LENGTH_INCREMENT

#define QUEUE_LENGTH_INCREMENT   32

Definition at line 6 of file tkqueue.h.

Function Documentation

tkqueue_add()

void tkqueue_add	(	tkqueue_t *	queue,
		token_t *	token )

Add a value to the token queue.

Parameters

queue	The queue where to add the item.
item	The value to add.

Definition at line 25 of file tkqueue.c.

{
  _queue_ensure_size(queue);
  queue->data[queue->length++] = token;
}

tkqueue_close()

void tkqueue_close

(

tkqueue_t *

queue

)

Close the given queue.

Parameters

The	queue to be closed.

Definition at line 18 of file tkqueue.c.

{
  free(queue->data);
  queue->data = NULL;
}

tkqueue_get()

token_t * tkqueue_get

(

tkqueue_t *

queue

)

Get the current value from the queue and increment the position for the next value.

Parameters

queue

The queue where to get the value.

Returns

NULL when the queue is empty.

Pointer to the item.

Definition at line 32 of file tkqueue.c.

{
  if (tkqueue_isempty(queue)) {
    return NULL;
  }
 
  return queue->data[queue->_current++];
}

tkqueue_init()

void tkqueue_init	(	tkqueue_t *	queue,
		unsigned int	initial_size )

Initializes the token queue.

Parameters

queue	The queue to be initialized.
initial_size	The initial number of items that fit the queue's memory data.

Definition at line 9 of file tkqueue.c.

{
  queue->length = 0;
  queue->_current = 0;
  queue->_size = initial_size;
  queue->data = malloc(sizeof(token_t*) * initial_size);
}

tkqueue_isempty()

int tkqueue_isempty

(

const tkqueue_t *

queue

)

Check if the given queue is empty.

Parameters

queue

The queue to check if it's empty.

Returns

1 on the queue is empty.

0 on the queue has items.

Definition at line 52 of file tkqueue.c.

{
  return queue->length == 0 || queue->_current >= queue->length;
}

tkqueue_peek()

token_t * tkqueue_peek

(

const tkqueue_t *

queue

)

Get the current value from the queue without increment the queue position.

Parameters

queue

The queue where to get the value.

Returns

NULL when the queue is empty.

Pointer to the item.

Definition at line 42 of file tkqueue.c.

{
  if (tkqueue_isempty(queue)) {
    return NULL;
  }
 
  return queue->data[queue->_current];
}