Restructuring project

View CHANGELOG on v1.5.0 for more information
This commit is contained in:
Leonardo committed 2019-06-21 16:07:03 -03:00
1 parent dad9b7a81f
commit 8010cce8c7
57 files changed
+1820 -206

No files matched your search

+654
View File
@@ -0,0 +1,654 @@
/**
* deque.h
*
* Creation Date: 21/06/2019
*
* Authors:
* Leonardo Vencovsky (https://github.com/LeoVen)
*
*/
/*****************************************************************************/
/********************************************************************* DEQUE */
/*****************************************************************************/
#ifndef CMC_DEQUE_H
#define CMC_DEQUE_H
#include <stdlib.h>
#include <stdbool.h>
#include <string.h>
#include <stdint.h>
#include <inttypes.h>
#include "utl/log.h"
#define DEQUE_GENERATE(PFX, SNAME, FMOD, V) \
DEQUE_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
DEQUE_GENERATE_SOURCE(PFX, SNAME, FMOD, V)
#define DEQUE_WRAPGEN_HEADER(PFX, SNAME, FMOD, K, V) \
DEQUE_GENERATE_HEADER(PFX, SNAME, FMOD, V)
#define DEQUE_WRAPGEN_SOURCE(PFX, SNAME, FMOD, K, V) \
DEQUE_GENERATE_SOURCE(PFX, SNAME, FMOD, V)
/* HEADER ********************************************************************/
#define DEQUE_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
\
/* Deque Structure */ \
typedef struct SNAME##_s \
{ \
/* Dynamic circular array of elements */ \
V *buffer; \
\
/* Current circular array capacity */ \
size_t capacity; \
\
/* Current amount of elements */ \
size_t count; \
\
/* Index representing the front of the deque */ \
size_t front; \
\
/* Index representing the back of the deque */ \
size_t back; \
\
/* Function that returns an iterator to the start of the deque */ \
struct SNAME##_iter_s (*it_start)(struct SNAME##_s *); \
\
/* Function that returns an iterator to the end of the deque */ \
struct SNAME##_iter_s (*it_end)(struct SNAME##_s *); \
\
} SNAME, *SNAME##_ptr; \
\
/* Deque Iterator */ \
typedef struct SNAME##_iter_s \
{ \
/* Target deque */ \
struct SNAME##_s *target; \
\
/* Cursor's position (index) */ \
size_t cursor; \
\
/* Keeps track of relative index to the iteration of elements */ \
size_t index; \
\
/* If the iterator has reached the start of the iteration */ \
bool start; \
\
/* If the iterator has reached the end of the iteration */ \
bool end; \
\
} SNAME##_iter, *SNAME##_iter_ptr; \
\
/* Collection Functions */ \
/* Collection Allocation and Deallocation */ \
FMOD SNAME *PFX##_new(size_t capacity); \
FMOD void PFX##_clear(SNAME *_deque_); \
FMOD void PFX##_free(SNAME *_deque_); \
/* Collection Input and Output */ \
FMOD bool PFX##_push_front(SNAME *_deque_, V element); \
FMOD bool PFX##_push_back(SNAME *_deque_, V element); \
FMOD bool PFX##_pop_front(SNAME *_deque_); \
FMOD bool PFX##_pop_back(SNAME *_deque_); \
/* Conditional Input and Output */ \
FMOD bool PFX##_push_front_if(SNAME *_deque_, V element, bool condition); \
FMOD bool PFX##_push_back_if(SNAME *_deque_, V element, bool condition); \
FMOD bool PFX##_pop_front_if(SNAME *_deque_, bool condition); \
FMOD bool PFX##_pop_back_if(SNAME *_deque_, bool condition); \
/* Element Access */ \
FMOD V PFX##_front(SNAME *_deque_); \
FMOD V PFX##_back(SNAME *_deque_); \
/* Collection State */ \
FMOD bool PFX##_contains(SNAME *_deque_, V element, int (*comparator)(V, V)); \
FMOD bool PFX##_empty(SNAME *_deque_); \
FMOD bool PFX##_full(SNAME *_deque_); \
FMOD size_t PFX##_count(SNAME *_deque_); \
FMOD size_t PFX##_capacity(SNAME *_deque_); \
\
/* Iterator Functions */ \
/* Iterator Allocation and Deallocation */ \
FMOD SNAME##_iter *PFX##_iter_new(SNAME *target); \
FMOD void PFX##_iter_free(SNAME##_iter *iter); \
/* Iterator Initialization */ \
FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target); \
/* Iterator State */ \
FMOD bool PFX##_iter_start(SNAME##_iter *iter); \
FMOD bool PFX##_iter_end(SNAME##_iter *iter); \
/* Iterator Movement */ \
FMOD void PFX##_iter_to_start(SNAME##_iter *iter); \
FMOD void PFX##_iter_to_end(SNAME##_iter *iter); \
FMOD bool PFX##_iter_next(SNAME##_iter *iter); \
FMOD bool PFX##_iter_prev(SNAME##_iter *iter); \
/* Iterator Access */ \
FMOD V PFX##_iter_value(SNAME##_iter *iter); \
FMOD V *PFX##_iter_rvalue(SNAME##_iter *iter); \
FMOD size_t PFX##_iter_index(SNAME##_iter *iter); \
\
/* Default Value */ \
static inline V PFX##_impl_default_value(void) \
{ \
V _empty_value_; \
\
memset(&_empty_value_, 0, sizeof(V)); \
\
return _empty_value_; \
} \
\
/* SOURCE ********************************************************************/
#define DEQUE_GENERATE_SOURCE(PFX, SNAME, FMOD, V) \
\
/* Implementation Detail Functions */ \
static bool PFX##_impl_grow(SNAME *_deque_); \
static SNAME##_iter PFX##_impl_it_start(SNAME *_deque_); \
static SNAME##_iter PFX##_impl_it_end(SNAME *_deque_); \
\
FMOD SNAME *PFX##_new(size_t capacity) \
{ \
if (capacity < 1) \
{ \
log_warn("Invalid capacity for %s given: %s", "Heap", capacity); \
return NULL; \
} \
\
SNAME *_deque_ = malloc(sizeof(SNAME)); \
\
if (!_deque_) \
{ \
log_info("%s allocation failed", "Deque"); \
return NULL; \
} \
\
_deque_->buffer = malloc(sizeof(V) * capacity); \
\
if (!_deque_->buffer) \
{ \
log_info("%s allocation failed", "Deque buffer"); \
free(_deque_); \
return NULL; \
} \
\
memset(_deque_->buffer, 0, sizeof(V) * capacity); \
\
_deque_->capacity = capacity; \
_deque_->count = 0; \
_deque_->front = 0; \
_deque_->back = 0; \
\
_deque_->it_start = PFX##_impl_it_start; \
_deque_->it_end = PFX##_impl_it_end; \
\
log_info("Deque at %p successfully allocated", _deque_); \
\
return _deque_; \
} \
\
FMOD void PFX##_clear(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
memset(_deque_->buffer, 0, sizeof(V) * _deque_->capacity); \
\
_deque_->count = 0; \
_deque_->front = 0; \
_deque_->back = 0; \
\
log_trace("Deque at %p cleared", _deque_); \
} \
\
FMOD void PFX##_free(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
free(_deque_->buffer); \
\
uintptr_t address = (uintptr_t)(void *)_deque_; \
\
free(_deque_); \
\
log_info("Heap at %p successfully deallocated", address); \
} \
\
FMOD bool PFX##_push_front(SNAME *_deque_, V element) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
if (PFX##_full(_deque_)) \
{ \
if (!PFX##_impl_grow(_deque_)) \
{ \
log_info("Deque at %p failed to be reallocated", _deque_); \
return false; \
} \
} \
\
_deque_->front = (_deque_->front == 0) ? _deque_->capacity - 1 : _deque_->front - 1; \
\
_deque_->buffer[_deque_->front] = element; \
\
log_trace("Element added at %" PRIuMAX " to Deque at %p", _deque_->front, _deque_); \
\
_deque_->count++; \
\
return true; \
} \
\
FMOD bool PFX##_push_back(SNAME *_deque_, V element) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
if (PFX##_full(_deque_)) \
{ \
if (!PFX##_impl_grow(_deque_)) \
{ \
log_info("Deque at %p failed to be reallocated", _deque_); \
return false; \
} \
} \
\
_deque_->buffer[_deque_->back] = element; \
\
log_trace("Element added at %" PRIuMAX " to Deque at %p", _deque_->back, _deque_); \
\
_deque_->back = (_deque_->back == _deque_->capacity - 1) ? 0 : _deque_->back + 1; \
\
_deque_->count++; \
\
return true; \
} \
\
FMOD bool PFX##_pop_front(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
if (PFX##_empty(_deque_)) \
{ \
log_debug("Attempt of removing an element from empty Deque at %p", _deque_); \
\
return false; \
} \
\
_deque_->buffer[_deque_->front] = PFX##_impl_default_value(); \
\
log_trace("Element removed from %" PRIuMAX " to Deque at %p", _deque_->front, _deque_); \
\
_deque_->front = (_deque_->front == _deque_->capacity - 1) ? 0 : _deque_->front + 1; \
\
_deque_->count--; \
\
return true; \
} \
\
FMOD bool PFX##_pop_back(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
{ \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
} \
\
if (PFX##_empty(_deque_)) \
{ \
log_debug("Attempt of removing an element from empty Deque at %p", _deque_); \
\
return false; \
} \
\
_deque_->back = (_deque_->back == 0) ? _deque_->capacity - 1 : _deque_->back - 1; \
\
_deque_->buffer[_deque_->back] = PFX##_impl_default_value(); \
\
log_trace("Element removed from %" PRIuMAX " to Deque at %p", _deque_->back, _deque_); \
\
_deque_->count--; \
\
return true; \
} \
\
FMOD bool PFX##_push_front_if(SNAME *_deque_, V element, bool condition) \
{ \
if (condition) \
return PFX##_push_front(_deque_, element); \
\
return false; \
} \
\
FMOD bool PFX##_push_back_if(SNAME *_deque_, V element, bool condition) \
{ \
if (condition) \
return PFX##_push_back(_deque_, element); \
\
return false; \
} \
\
FMOD bool PFX##_pop_front_if(SNAME *_deque_, bool condition) \
{ \
if (condition) \
return PFX##_pop_front(_deque_); \
\
return false; \
} \
\
FMOD bool PFX##_pop_back_if(SNAME *_deque_, bool condition) \
{ \
if (condition) \
return PFX##_pop_back(_deque_); \
\
return false; \
} \
\
FMOD V PFX##_front(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
if (PFX##_empty(_deque_)) \
{ \
log_debug("Attempt to access element from empty Deque at %p", _deque_); \
\
PFX##_impl_default_value(); \
} \
\
log_trace("Element access at %" PRIuMAX "", _deque_->front); \
\
return _deque_->buffer[_deque_->front]; \
} \
\
FMOD V PFX##_back(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
if (PFX##_empty(_deque_)) \
{ \
log_debug("Attempt to access element from empty Deque at %p", _deque_); \
\
PFX##_impl_default_value(); \
} \
\
size_t index = (_deque_->back == 0) ? _deque_->capacity - 1 : _deque_->back - 1; \
\
log_trace("Element access at %" PRIuMAX "", index); \
\
return _deque_->buffer[index]; \
} \
\
FMOD bool PFX##_contains(SNAME *_deque_, V element, int (*comparator)(V, V)) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
if (comparator == NULL) \
log_fatal("Invalid null pointer parameter: %s", "comparator"); \
\
for (size_t i = _deque_->front, j = 0; j < _deque_->count; i = (i + 1) % _deque_->count, j++) \
{ \
if (comparator(_deque_->buffer[i], element) == 0) \
return true; \
} \
\
return false; \
} \
\
FMOD bool PFX##_empty(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
return _deque_->count == 0; \
} \
\
FMOD bool PFX##_full(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
return _deque_->count >= _deque_->capacity; \
} \
\
FMOD size_t PFX##_count(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
return _deque_->count; \
} \
\
FMOD size_t PFX##_capacity(SNAME *_deque_) \
{ \
if (_deque_ == NULL) \
log_fatal("Invalid null pointer parameter: %s", "_deque_"); \
\
return _deque_->capacity; \
} \
\
FMOD SNAME##_iter *PFX##_iter_new(SNAME *target) \
{ \
SNAME##_iter *iter = malloc(sizeof(SNAME##_iter)); \
\
if (!iter) \
{ \
log_info("%s allocation failed", "Deque Iterator"); \
return NULL; \
} \
\
PFX##_iter_init(iter, target); \
\
log_info("Deque Iterator allocated at %p referencing Heap at %p", iter, target); \
\
return iter; \
} \
\
FMOD void PFX##_iter_free(SNAME##_iter *iter) \
{ \
uintptr_t address = (uintptr_t)(void *)iter; \
\
free(iter); \
\
log_info("Deque Iterator deallocated at %" PRIxPTR "", address); \
} \
\
FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target) \
{ \
if (target == NULL) \
log_fatal("Heap Iterator at %p initialized with null pointer target", iter); \
\
if (PFX##_empty(target)) \
log_warn("Deque Iterator at %p initialized with empty target", iter); \
\
iter->target = target; \
iter->cursor = target->front; \
iter->index = 0; \
iter->start = true; \
iter->end = PFX##_empty(target); \
} \
\
FMOD bool PFX##_iter_start(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
return PFX##_empty(iter->target) || iter->start; \
} \
\
FMOD bool PFX##_iter_end(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
return PFX##_empty(iter->target) || iter->end; \
} \
\
FMOD void PFX##_iter_to_start(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
iter->cursor = iter->target->front; \
iter->index = 0; \
iter->start = true; \
iter->end = PFX##_empty(iter->target); \
\
log_trace("Deque Iterator at %p with cursor at %" PRIuMAX "", iter, iter->cursor); \
} \
\
FMOD void PFX##_iter_to_end(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
if (PFX##_empty(iter->target)) \
iter->cursor = 0; \
else \
iter->cursor = (iter->target->back == 0) ? iter->target->capacity - 1 : iter->target->back - 1; \
\
iter->index = iter->target->count - 1; \
iter->start = PFX##_empty(iter->target); \
iter->end = true; \
\
log_trace("Deque Iterator at %p with cursor at %" PRIuMAX "", iter, iter->cursor); \
} \
\
FMOD bool PFX##_iter_next(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
if (iter->end) \
return false; \
\
iter->start = PFX##_empty(iter->target); \
\
if (iter->index == iter->target->count - 1) \
{ \
log_trace("Deque Iterator at %p reached the end of Deque %p", iter, iter->target); \
iter->end = true; \
} \
else \
{ \
iter->cursor = (iter->cursor + 1) % (iter->target->capacity); \
iter->index++; \
\
log_trace("Deque Iterator at %p moved to %" PRIuMAX "", iter, iter->cursor); \
} \
\
return true; \
} \
\
FMOD bool PFX##_iter_prev(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
if (iter->start) \
return false; \
\
iter->end = PFX##_empty(iter->target); \
\
if (iter->index == 0) \
{ \
log_trace("Deque Iterator at %p reached the start of Deque %p", iter, iter->target); \
iter->start = true; \
} \
else \
{ \
iter->cursor = (iter->cursor == 0) ? iter->target->capacity - 1 : iter->cursor - 1; \
iter->index--; \
\
log_trace("Deque Iterator at %p moved to %" PRIuMAX "", iter, iter->cursor); \
} \
\
return true; \
} \
\
FMOD V PFX##_iter_value(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
if (PFX##_empty(iter->target)) \
{ \
log_debug("Attempt to access element from iterator %p with empty target %p", iter, iter->target); \
PFX##_impl_default_value(); \
} \
\
log_trace("Element access at %" PRIuMAX "", iter->cursor); \
\
return iter->target->buffer[iter->cursor]; \
} \
\
FMOD V *PFX##_iter_rvalue(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
if (PFX##_empty(iter->target)) \
{ \
log_debug("Attempt to access element from iterator %p with empty target %p", iter, iter->target); \
return NULL; \
} \
\
log_trace("Element access at %" PRIuMAX "", iter->cursor); \
\
return &(iter->target->buffer[iter->cursor]); \
} \
\
FMOD size_t PFX##_iter_index(SNAME##_iter *iter) \
{ \
if (iter == NULL) \
log_fatal("Invalid null pointer parameter: %s", "iter"); \
\
return iter->index; \
} \
\
static bool PFX##_impl_grow(SNAME *_deque_) \
{ \
size_t new_capacity = _deque_->capacity * 2; \
\
V *new_buffer = malloc(sizeof(V) * new_capacity); \
\
if (!new_buffer) \
{ \
log_info("%s reallocation failed", "Deque buffer"); \
return false; \
} \
\
for (size_t i = _deque_->front, j = 0; j < _deque_->count; i = (i + 1) % _deque_->capacity, j++) \
{ \
new_buffer[j] = _deque_->buffer[i]; \
} \
\
free(_deque_->buffer); \
\
_deque_->buffer = new_buffer; \
_deque_->capacity = new_capacity; \
_deque_->front = 0; \
_deque_->back = _deque_->count; \
\
return true; \
} \
\
static SNAME##_iter PFX##_impl_it_start(SNAME *_deque_) \
{ \
SNAME##_iter iter; \
\
PFX##_iter_init(&iter, _deque_); \
\
return iter; \
} \
\
static SNAME##_iter PFX##_impl_it_end(SNAME *_deque_) \
{ \
SNAME##_iter iter; \
\
PFX##_iter_init(&iter, _deque_); \
PFX##_iter_to_end(&iter); \
\
return iter; \
}
#endif /* CMC_DEQUE_H */