queue.h

Go to the documentation of this file.

/*
BSD 3-Clause License
 
Copyright (c) 2022, KriztoferY (https://github.com/KriztoferY)
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef QUEUE_H
#define QUEUE_H
 
#include <stddef.h>    // size_t
#include <stdbool.h>   // bool
 
typedef struct queue Queue;
 
Queue* Queue_create(size_t elem_sz);
 
void Queue_destroy(Queue* queue);
 
size_t Queue_capacity(Queue* queue);
 
bool Queue_empty(Queue* queue);
 
size_t Queue_size(Queue* queue);
 
bool Queue_front(Queue* queue, void* elem);
 
bool Queue_enqueue(Queue* queue, void const* elem);
 
bool Queue_dequeue(Queue* queue);
 
void Queue_print(Queue* queue, char const* sep, bool vertical,
                 void (*print_element)(void const*));
 
#endif /* QUEUE_H */