saxbospiral.h

Go to the documentation of this file.

/*
 * This source file forms part of libsxbp, a library which generates
 * experimental 2D spiral-like shapes based on input binary data.
 */

#ifndef SAXBOPHONE_SAXBOSPIRAL_SAXBOSPIRAL_H
#define SAXBOPHONE_SAXBOSPIRAL_SAXBOSPIRAL_H

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <time.h>


#ifdef __cplusplus
extern "C"{
#endif

typedef struct sxbp_version_t {
    uint16_t major;
    uint16_t minor;
    uint16_t patch;
    const char* string;
} sxbp_version_t;

extern const sxbp_version_t LIB_SXBP_VERSION;

bool sxbp_version_less_than(sxbp_version_t a, sxbp_version_t b);

bool sxbp_version_greater_than(sxbp_version_t a, sxbp_version_t b);

bool sxbp_version_equal_to(sxbp_version_t a, sxbp_version_t b);

typedef enum sxbp_status_t {
    SXBP_STATE_UNKNOWN = 0, 
    SXBP_OPERATION_OK, 
    SXBP_OPERATION_FAIL, 
    SXBP_MALLOC_REFUSED, 
    SXBP_IMPOSSIBLE_CONDITION, 
    SXBP_NOT_IMPLEMENTED, 
} sxbp_status_t;

typedef uint8_t sxbp_direction_t;

#define SXBP_UP 0 
#define SXBP_RIGHT 1 
#define SXBP_DOWN 2 
#define SXBP_LEFT 3 
typedef int8_t sxbp_rotation_t;

#define SXBP_CLOCKWISE 1 
#define SXBP_ANTI_CLOCKWISE -1 
typedef uint32_t sxbp_length_t;

typedef struct sxbp_line_t {
    sxbp_direction_t direction : 2;
    sxbp_length_t length : 30;
} sxbp_line_t;

typedef int32_t sxbp_tuple_item_t;

typedef struct sxbp_tuple_t {
    sxbp_tuple_item_t x;
    sxbp_tuple_item_t y;
} sxbp_tuple_t;

typedef sxbp_tuple_t sxbp_vector_t;
typedef sxbp_tuple_t sxbp_co_ord_t;

typedef struct sxbp_co_ord_array_t {
    sxbp_co_ord_t* items;
    size_t size;
} sxbp_co_ord_array_t;

typedef struct sxbp_co_ord_cache_t {
    sxbp_co_ord_array_t co_ords;
    size_t validity;
} sxbp_co_ord_cache_t;

typedef struct sxbp_spiral_t {
    uint32_t size;
    sxbp_line_t* lines;
    sxbp_co_ord_cache_t co_ord_cache;
    bool collides;
    uint32_t collider;
    uint32_t solved_count;
    uint32_t seconds_spent;
    uint32_t seconds_accuracy;
    clock_t current_clock_ticks;
    clock_t elapsed_clock_ticks;
} sxbp_spiral_t;

typedef struct sxbp_buffer_t {
    uint8_t* bytes;
    size_t size;
} sxbp_buffer_t;

extern const sxbp_vector_t SXBP_VECTOR_DIRECTIONS[4];

#ifdef __cplusplus
} // extern "C"
#endif

// end of header file
#endif