/*****************************************************************************
 * Copyright (c) 2005  Daniel Lerch Hostalot <http://daniellerch.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a 
 * copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the 
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/


#ifndef __QUEUE_H__
#define __QUEUE_H__

#ifdef __cplusplus
extern "C" {
#endif

#include "list.h"
#include <stdio.h>

/**
 * Tipo de representacion de una cola.
 */
#define queue_t list_t

/**
 * Crea un tipo queue. 
 *
 * @return list_t*: tipo cola.
 */
#define queue_new list_new

/**
 * Libera la memoria utilizada por la cola. 
 * Si no se proporciona una funcion para liberar los elementos insertador, 
 * (Pasando NULL como argumento) estos no se liberaran.
 *
 * @param *obj: objeto con el que trabaja.
 * @param freefunc: funcion para liberar la memoria de los elementos.
 */
#define queue_free list_free

/**
 * Pone un elemento en la cola.
 *
 * @param *obj: objeto con el que trabaja.
 * @param element: elemento a insertar.
 */
#define queue_enqueue list_add_last

/**
 * Saca un elemento de la cola.
 *
 * @param *obj: objeto con el que trabaja.
 * @return void*: apuntador al elemento.
 */
#define queue_dequeue list_remove_first

/**
 * Retorna el numero de elementos en la cola.
 *
 * @param *obj: objeto con el que trabaja.
 * @return int: numero de elementos en la cola.
 */
#define queue_size list_size



#ifdef __cplusplus
}
#endif

#endif