C Container Collection (CCC)
Loading...
Searching...
No Matches
buffer.h
Go to the documentation of this file.
1
54#ifndef CCC_BUFFER_H
55#define CCC_BUFFER_H
56
58#include <stddef.h>
61#include "private/private_buffer.h"
62#include "types.h"
63
73typedef struct CCC_Buffer CCC_Buffer;
74
93#define CCC_buffer_default(type_name) CCC_private_buffer_default(type_name)
94
125#define CCC_buffer_for(type_name, capacity, count, data_pointer...) \
126 CCC_private_buffer_for(type_name, capacity, count, data_pointer)
127
181#define CCC_buffer_from( \
182 allocator, optional_capacity, compound_literal_array... \
183) \
184 CCC_private_buffer_from( \
185 allocator, optional_capacity, compound_literal_array \
186 )
187
216#define CCC_buffer_with_capacity(type_name, allocator, capacity) \
217 CCC_private_buffer_with_capacity(type_name, allocator, capacity)
218
238#define CCC_buffer_with_storage(count, compound_literal_array...) \
239 CCC_private_buffer_with_storage(count, compound_literal_array)
240
247[[nodiscard]] CCC_Result CCC_buffer_reserve(
248 CCC_Buffer *buffer, size_t to_add, CCC_Allocator const *allocator
249);
250
292[[nodiscard]] CCC_Result CCC_buffer_copy(
293 CCC_Buffer *destination,
294 CCC_Buffer const *source,
295 CCC_Allocator const *allocator
296);
297
311[[nodiscard]] CCC_Result CCC_buffer_allocate(
312 CCC_Buffer *buffer, size_t capacity, CCC_Allocator const *allocator
313);
314
327[[nodiscard]] void *
328CCC_buffer_allocate_back(CCC_Buffer *buffer, CCC_Allocator const *allocator);
329
343[[nodiscard]] void *CCC_buffer_push_back(
344 CCC_Buffer *buffer, void const *data, CCC_Allocator const *allocator
345);
346
357#define CCC_buffer_emplace_back( \
358 buffer_pointer, allocator_pointer, type_compound_literal... \
359) \
360 CCC_private_buffer_emplace_back( \
361 buffer_pointer, allocator_pointer, type_compound_literal \
362 )
363
379[[nodiscard]] void *CCC_buffer_insert(
380 CCC_Buffer *buffer,
381 size_t index,
382 void const *data,
383 CCC_Allocator const *allocator
384);
385
391CCC_Result CCC_buffer_pop_back(CCC_Buffer *buffer);
392
401CCC_Result CCC_buffer_pop_back_n(CCC_Buffer *buffer, size_t count);
402
414CCC_Result CCC_buffer_erase(CCC_Buffer *buffer, size_t index);
415
434[[nodiscard]] void *CCC_buffer_at(CCC_Buffer const *buffer, size_t index);
435
447#define CCC_buffer_as(buffer_pointer, type_name, index) \
448 ((type_name *)CCC_buffer_at(buffer_pointer, index))
449
455[[nodiscard]] CCC_Count
456CCC_buffer_index(CCC_Buffer const *buffer, void const *slot);
457
462[[nodiscard]] void *CCC_buffer_back(CCC_Buffer const *buffer);
463
469#define CCC_buffer_back_as(buffer_pointer, type_name) \
470 ((type_name *)CCC_buffer_back(buffer_pointer))
471
476[[nodiscard]] void *CCC_buffer_front(CCC_Buffer const *buffer);
477
483#define CCC_buffer_front_as(buffer_pointer, type_name) \
484 ((type_name *)CCC_buffer_front(buffer_pointer))
485
496void *
497CCC_buffer_move(CCC_Buffer const *buffer, size_t destination, size_t source);
498
512CCC_Result
513CCC_buffer_write(CCC_Buffer const *buffer, size_t index, void const *data);
514
526#define CCC_buffer_emplace(buffer_pointer, index, type_compound_literal...) \
527 CCC_private_buffer_emplace(buffer_pointer, index, type_compound_literal)
528
544CCC_Result CCC_buffer_swap(
545 CCC_Buffer const *buffer, void *temp, size_t index, size_t swap_index
546);
547
559[[nodiscard]] void *CCC_buffer_begin(CCC_Buffer const *buffer);
560
566[[nodiscard]] void *
567CCC_buffer_next(CCC_Buffer const *buffer, void const *iterator);
568
576[[nodiscard]] void *CCC_buffer_end(CCC_Buffer const *buffer);
577
584[[nodiscard]] void *CCC_buffer_reverse_begin(CCC_Buffer const *buffer);
585
592[[nodiscard]] void *
593CCC_buffer_reverse_next(CCC_Buffer const *buffer, void const *iterator);
594
600[[nodiscard]] void *CCC_buffer_reverse_end(CCC_Buffer const *buffer);
601
616CCC_Result CCC_buffer_count_plus(CCC_Buffer *buffer, size_t count);
617
626CCC_Result CCC_buffer_count_minus(CCC_Buffer *buffer, size_t count);
627
636CCC_Result CCC_buffer_count_set(CCC_Buffer *buffer, size_t count);
637
644[[nodiscard]] CCC_Count CCC_buffer_count(CCC_Buffer const *buffer);
645
651[[nodiscard]] CCC_Count CCC_buffer_capacity(CCC_Buffer const *buffer);
652
657[[nodiscard]] CCC_Count CCC_buffer_sizeof_type(CCC_Buffer const *buffer);
658
666[[nodiscard]] CCC_Count CCC_buffer_count_bytes(CCC_Buffer const *buffer);
667
674[[nodiscard]] CCC_Count CCC_buffer_capacity_bytes(CCC_Buffer const *buffer);
675
679[[nodiscard]] CCC_Tribool CCC_buffer_is_empty(CCC_Buffer const *buffer);
680
684[[nodiscard]] CCC_Tribool CCC_buffer_is_full(CCC_Buffer const *buffer);
685
692[[nodiscard]] void *CCC_buffer_data(CCC_Buffer const *buffer);
693
712CCC_Result CCC_buffer_clear_and_free(
713 CCC_Buffer *buffer,
714 CCC_Destructor const *destructor,
715 CCC_Allocator const *allocator
716);
717
728CCC_Result
729CCC_buffer_clear(CCC_Buffer *buffer, CCC_Destructor const *destructor);
730
736#ifdef BUFFER_USING_NAMESPACE_CCC
737/* NOLINTBEGIN(readability-identifier-naming) */
738typedef CCC_Buffer Buffer;
739# define buffer_default(argument) CCC_buffer_default(argument)
740# define buffer_for(arguments...) CCC_buffer_for(arguments)
741# define buffer_with_storage(arguments...) CCC_buffer_with_storage(arguments)
742# define buffer_with_allocator(arguments...) \
743 CCC_buffer_with_allocator(arguments)
744# define buffer_with_capacity(arguments...) \
745 CCC_buffer_with_capacity(arguments)
746# define buffer_from(arguments...) CCC_buffer_from(arguments)
747# define buffer_allocate(arguments...) CCC_buffer_allocate(arguments)
748# define buffer_reserve(arguments...) CCC_buffer_reserve(arguments)
749# define buffer_copy(arguments...) CCC_buffer_copy(arguments)
750# define buffer_clear(arguments...) CCC_buffer_clear(arguments)
751# define buffer_clear_and_free(arguments...) \
752 CCC_buffer_clear_and_free(arguments)
753# define buffer_count(arguments...) CCC_buffer_count(arguments)
754# define buffer_count_bytes(arguments...) CCC_buffer_count_bytes(arguments)
755# define buffer_count_plus(arguments...) CCC_buffer_count_plus(arguments)
756# define buffer_count_minus(arguments...) CCC_buffer_count_minus(arguments)
757# define buffer_count_set(arguments...) CCC_buffer_count_set(arguments)
758# define buffer_capacity(arguments...) CCC_buffer_capacity(arguments)
759# define buffer_capacity_bytes(arguments...) \
760 CCC_buffer_capacity_bytes(arguments)
761# define buffer_sizeof_type(arguments...) CCC_buffer_sizeof_type(arguments)
762# define buffer_index(arguments...) CCC_buffer_index(arguments)
763# define buffer_is_full(arguments...) CCC_buffer_is_full(arguments)
764# define buffer_is_empty(arguments...) CCC_buffer_is_empty(arguments)
765# define buffer_at(arguments...) CCC_buffer_at(arguments)
766# define buffer_as(arguments...) CCC_buffer_as(arguments)
767# define buffer_back(arguments...) CCC_buffer_back(arguments)
768# define buffer_back_as(arguments...) CCC_buffer_back_as(arguments)
769# define buffer_front(arguments...) CCC_buffer_front(arguments)
770# define buffer_front_as(arguments...) CCC_buffer_front_as(arguments)
771# define buffer_allocate_back(arguments...) \
772 CCC_buffer_allocate_back(arguments)
773# define buffer_emplace(arguments...) CCC_buffer_emplace(arguments)
774# define buffer_emplace_back(arguments...) CCC_buffer_emplace_back(arguments)
775# define buffer_push_back(arguments...) CCC_buffer_push_back(arguments)
776# define buffer_pop_back(arguments...) CCC_buffer_pop_back(arguments)
777# define buffer_pop_back_n(arguments...) CCC_buffer_pop_back_n(arguments)
778# define buffer_move(arguments...) CCC_buffer_move(arguments)
779# define buffer_swap(arguments...) CCC_buffer_swap(arguments)
780# define buffer_write(arguments...) CCC_buffer_write(arguments)
781# define buffer_erase(arguments...) CCC_buffer_erase(arguments)
782# define buffer_insert(arguments...) CCC_buffer_insert(arguments)
783# define buffer_begin(arguments...) CCC_buffer_begin(arguments)
784# define buffer_next(arguments...) CCC_buffer_next(arguments)
785# define buffer_end(arguments...) CCC_buffer_end(arguments)
786# define buffer_reverse_begin(arguments...) \
787 CCC_buffer_reverse_begin(arguments)
788# define buffer_reverse_next(arguments...) CCC_buffer_reverse_next(arguments)
789# define buffer_reverse_end(arguments...) CCC_buffer_reverse_end(arguments)
790# define buffer_data(arguments...) CCC_buffer_data(arguments)
791/* NOLINTEND(readability-identifier-naming) */
792#endif /* BUFFER_USING_NAMESPACE_CCC */
793
794#endif /* CCC_BUFFER_H */
CCC_buffer_count_plus
CCC_Result CCC_buffer_count_plus(CCC_Buffer *buffer, size_t count)
add count to the size of the buffer.
CCC_buffer_clear
CCC_Result CCC_buffer_clear(CCC_Buffer *buffer, CCC_Destructor const *destructor)
Set size of buffer to 0 and call destroy on each element if needed. O(1) if no destroy is provided,...
CCC_buffer_copy
CCC_Result CCC_buffer_copy(CCC_Buffer *destination, CCC_Buffer const *source, CCC_Allocator const *allocator)
Copy the buffer from source to newly initialized destination.
CCC_buffer_allocate_back
void * CCC_buffer_allocate_back(CCC_Buffer *buffer, CCC_Allocator const *allocator)
allocates a new slot from the Buffer at the end of the contiguous array. A slot is equivalent to one ...
CCC_buffer_count_bytes
CCC_Count CCC_buffer_count_bytes(CCC_Buffer const *buffer)
Return the bytes in the Buffer given the current count of active elements.
CCC_buffer_at
void * CCC_buffer_at(CCC_Buffer const *buffer, size_t index)
return the element at slot index in buf.
CCC_buffer_data
void * CCC_buffer_data(CCC_Buffer const *buffer)
return a reference to the underlying data of the buffer.
CCC_buffer_reverse_begin
void * CCC_buffer_reverse_begin(CCC_Buffer const *buffer)
obtain the address of the last element in the Buffer in preparation for iteration according to size.
CCC_buffer_count_set
CCC_Result CCC_buffer_count_set(CCC_Buffer *buffer, size_t count)
Set the Buffer size to n.
CCC_buffer_index
CCC_Count CCC_buffer_index(CCC_Buffer const *buffer, void const *slot)
return the index of an element known to be in the buffer.
CCC_buffer_pop_back
CCC_Result CCC_buffer_pop_back(CCC_Buffer *buffer)
pop the back element from the Buffer according to size.
CCC_buffer_push_back
void * CCC_buffer_push_back(CCC_Buffer *buffer, void const *data, CCC_Allocator const *allocator)
return the newly pushed data into the last slot of the buffer according to size.
CCC_buffer_reserve
CCC_Result CCC_buffer_reserve(CCC_Buffer *buffer, size_t to_add, CCC_Allocator const *allocator)
Reserves space for at least to_add more elements.
CCC_buffer_front
void * CCC_buffer_front(CCC_Buffer const *buffer)
return the first element in the Buffer at index 0.
CCC_buffer_move
void * CCC_buffer_move(CCC_Buffer const *buffer, size_t destination, size_t source)
Move data at index source to destination according to capacity.
CCC_buffer_erase
CCC_Result CCC_buffer_erase(CCC_Buffer *buffer, size_t index)
erase element at slot index according to size of the Buffer maintaining contiguous storage of element...
CCC_buffer_capacity
CCC_Count CCC_buffer_capacity(CCC_Buffer const *buffer)
Return the current capacity of total possible slots.
CCC_buffer_count_minus
CCC_Result CCC_buffer_count_minus(CCC_Buffer *buffer, size_t count)
Subtract count from the size of the buffer.
CCC_buffer_is_empty
CCC_Tribool CCC_buffer_is_empty(CCC_Buffer const *buffer)
return true if the size of the Buffer is 0.
CCC_buffer_next
void * CCC_buffer_next(CCC_Buffer const *buffer, void const *iterator)
advance the iterator to the next slot in the Buffer according to size.
CCC_buffer_insert
void * CCC_buffer_insert(CCC_Buffer *buffer, size_t index, void const *data, CCC_Allocator const *allocator)
insert data at slot index according to size of the Buffer maintaining contiguous storage of elements ...
CCC_buffer_swap
CCC_Result CCC_buffer_swap(CCC_Buffer const *buffer, void *temp, size_t index, size_t swap_index)
swap elements at index and swap_index according to capacity of the bufer.
CCC_buffer_count
CCC_Count CCC_buffer_count(CCC_Buffer const *buffer)
obtain the count of Buffer active slots.
CCC_buffer_clear_and_free
CCC_Result CCC_buffer_clear_and_free(CCC_Buffer *buffer, CCC_Destructor const *destructor, CCC_Allocator const *allocator)
Set size of buffer to 0 and call destroy on each element if needed. Free the underlying Buffer settin...
CCC_buffer_end
void * CCC_buffer_end(CCC_Buffer const *buffer)
return the end position of the Buffer according to size.
CCC_buffer_reverse_next
void * CCC_buffer_reverse_next(CCC_Buffer const *buffer, void const *iterator)
advance the iterator to the next slot in the Buffer according to size and in reverse order.
CCC_buffer_sizeof_type
CCC_Count CCC_buffer_sizeof_type(CCC_Buffer const *buffer)
The size of the type being stored contiguously in the buffer.
CCC_buffer_begin
void * CCC_buffer_begin(CCC_Buffer const *buffer)
obtain the base address of the Buffer in preparation for iteration.
CCC_buffer_write
CCC_Result CCC_buffer_write(CCC_Buffer const *buffer, size_t index, void const *data)
write data to Buffer at slot at index index according to capacity.
CCC_buffer_capacity_bytes
CCC_Count CCC_buffer_capacity_bytes(CCC_Buffer const *buffer)
Return the bytes in the Buffer given the current capacity elements.
CCC_buffer_pop_back_n
CCC_Result CCC_buffer_pop_back_n(CCC_Buffer *buffer, size_t count)
pop count elements from the back of the Buffer according to size.
CCC_buffer_is_full
CCC_Tribool CCC_buffer_is_full(CCC_Buffer const *buffer)
return true if the size of the Buffer equals capacity.
CCC_buffer_back
void * CCC_buffer_back(CCC_Buffer const *buffer)
return the final element in the Buffer according the current size.
CCC_buffer_reverse_end
void * CCC_buffer_reverse_end(CCC_Buffer const *buffer)
return the reverse_end position of the buffer.
CCC_buffer_allocate
CCC_Result CCC_buffer_allocate(CCC_Buffer *buffer, size_t capacity, CCC_Allocator const *allocator)
allocates the Buffer to the specified size according to the user defined allocation function.
CCC_Allocator
The type passed by reference to any container function that may need to allocate memory....
Definition: types.h:376
CCC_Buffer
Definition: private_buffer.h:32
CCC_Buffer::capacity
size_t capacity
Definition: private_buffer.h:38
CCC_Buffer::count
size_t count
Definition: private_buffer.h:36
CCC_Buffer::data
void * data
Definition: private_buffer.h:34
CCC_Count
A type for returning an unsigned integer from a container for counting. Intended to count sizes,...
Definition: types.h:244
CCC_Destructor
The type passed by reference to any container function that may need to destroy elements....
Definition: types.h:464
types.h
The C Container Collection Fundamental Types.
CCC_Tribool
CCC_Tribool
A three state boolean to allow for an error state. Error is -1, False is 0, and True is 1.
Definition: types.h:178
CCC_Result
CCC_Result
A result of actions on containers.
Definition: types.h:192