mirror of
https://github.com/bkthomps/Containers.git
synced 2025-11-16 12:34:47 +00:00
56 lines
1.8 KiB
C
56 lines
1.8 KiB
C
/*
|
|
* Copyright (c) 2017-2019 Bailey Thompson
|
|
*
|
|
* 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 CONTAINERS_QUEUE_H
|
|
#define CONTAINERS_QUEUE_H
|
|
|
|
/**
|
|
* The queue data structure, which adapts a container to provide a queue
|
|
* (first-in first-out). Adapts the deque container.
|
|
*/
|
|
typedef struct internal_queue *queue;
|
|
|
|
/* Starting */
|
|
queue queue_init(size_t data_size);
|
|
|
|
/* Utility */
|
|
int queue_size(queue me);
|
|
int queue_is_empty(queue me);
|
|
int queue_trim(queue me);
|
|
void queue_copy_to_array(void *arr, queue me);
|
|
|
|
/* Adding */
|
|
int queue_push(queue me, void *data);
|
|
|
|
/* Removing */
|
|
int queue_pop(void *data, queue me);
|
|
|
|
/* Getting */
|
|
int queue_front(void *data, queue me);
|
|
int queue_back(void *data, queue me);
|
|
|
|
/* Ending */
|
|
int queue_clear(queue me);
|
|
queue queue_destroy(queue me);
|
|
|
|
#endif /* CONTAINERS_QUEUE_H */
|