Merge pull request #81 from saxbophone/develop

saxbophone · web-flow · commit c79b44fa05bd · 2016-10-15T21:55:46.000+01:00
Version 0.14.0
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,7 +1,7 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
 
-project(saxbospiral VERSION 0.13.1 LANGUAGES C)
+project(saxbospiral VERSION 0.14.0 LANGUAGES C)
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(
diff --git a/saxbospiral.png b/saxbospiral.png
diff --git a/saxbospiral/initialise.c b/saxbospiral/initialise.c
@@ -24,7 +24,7 @@ direction_t change_direction(direction_t current, rotation_t turn) {
  * instructions which are then used to build the pattern.
  * returns a status_t struct with error information (if needed)
  */
-status_t init_spiral(buffer_t buffer, spiral_t * spiral) {
+status_t init_spiral(buffer_t buffer, spiral_t* spiral) {
     // result status object
     status_t result;
     // number of lines is number of bits of the data, + 1 for the first UP line
diff --git a/saxbospiral/initialise.h b/saxbospiral/initialise.h
@@ -21,7 +21,7 @@ direction_t change_direction(direction_t current, rotation_t turn);
  * instructions which are then used to build the pattern.
  * returns a status_t struct with error information (if needed)
  */
-status_t init_spiral(buffer_t buffer, spiral_t * spiral);
+status_t init_spiral(buffer_t buffer, spiral_t* spiral);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/saxbospiral/plot.c b/saxbospiral/plot.c
@@ -1,4 +1,3 @@
-#include <stdint.h>
 #include <stdlib.h>
 
 #include "saxbospiral.h"
@@ -29,7 +28,7 @@ size_t sum_lines(spiral_t spiral, size_t start, size_t end) {
  * returns a status struct with error information (if any)
  */
 status_t spiral_points(
-    spiral_t spiral, co_ord_array_t * output, co_ord_t start_point,
+    spiral_t spiral, co_ord_array_t* output, co_ord_t start_point,
     size_t start, size_t end
 ) {
     // prepare result status
@@ -77,7 +76,7 @@ status_t spiral_points(
  * co_ord_cache member and are re-used if they are still valid
  * returns a status struct with error information (if any)
  */
-status_t cache_spiral_points(spiral_t * spiral, size_t limit) {
+status_t cache_spiral_points(spiral_t* spiral, size_t limit) {
     // prepare result status
     status_t result = {{0, 0, 0}, 0};
     // the amount of space needed is the sum of all line lengths + 1 for end
diff --git a/saxbospiral/plot.h b/saxbospiral/plot.h
@@ -24,7 +24,7 @@ size_t sum_lines(spiral_t spiral, size_t start, size_t end);
  * returns a status struct with error information (if any)
  */
 status_t spiral_points(
-    spiral_t spiral, co_ord_array_t * output, co_ord_t start_point,
+    spiral_t spiral, co_ord_array_t* output, co_ord_t start_point,
     size_t start, size_t end
 );
 
@@ -37,7 +37,7 @@ status_t spiral_points(
  * spiral's co_ord_cache member and are re-used if they are still valid
  * returns a status struct with error information (if any)
  */
-status_t cache_spiral_points(spiral_t * spiral, size_t limit);
+status_t cache_spiral_points(spiral_t* spiral, size_t limit);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/saxbospiral/render.c b/saxbospiral/render.c
@@ -23,7 +23,7 @@ extern "C"{
  * NOTE: This should NEVER be called with a pointer to anything other than a
  * 2-item struct of type co_ord_t
  */
-static void get_bounds(spiral_t spiral, co_ord_t * bounds) {
+static void get_bounds(spiral_t spiral, co_ord_t* bounds) {
     tuple_item_t min_x = 0;
     tuple_item_t min_y = 0;
     tuple_item_t max_x = 0;
@@ -54,7 +54,7 @@ static void get_bounds(spiral_t spiral, co_ord_t * bounds) {
  * representing a monochromatic image of the rendered spiral to the bitmap
  * returns a status struct with error information (if any)
  */
-status_t render_spiral(spiral_t spiral, bitmap_t * image) {
+status_t render_spiral(spiral_t spiral, bitmap_t* image) {
     // create result status struct
     status_t result = {{0, 0, 0}, 0};
     // plot co-ords of spiral into it's cache
diff --git a/saxbospiral/render.h b/saxbospiral/render.h
@@ -27,7 +27,7 @@ typedef struct bitmap_t {
  * representing a monochromatic image of the rendered spiral to the bitmap
  * returns a status struct with error information (if any)
  */
-status_t render_spiral(spiral_t spiral, bitmap_t * image);
+status_t render_spiral(spiral_t spiral, bitmap_t* image);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/saxbospiral/render_backends/png_backend.c b/saxbospiral/render_backends/png_backend.c
@@ -17,7 +17,7 @@ static void buffer_write_data(
     png_structp png_ptr, png_bytep data, png_size_t length
 ) {
     // retrieve pointer to buffer
-    buffer_t * p = (buffer_t *)png_get_io_ptr(png_ptr);
+    buffer_t* p = (buffer_t*)png_get_io_ptr(png_ptr);
     size_t new_size = p->size + length;
     // if buffer bytes pointer is not NULL, then re-allocate
     if(p->bytes != NULL) {
@@ -55,7 +55,7 @@ void cleanup_png_lib(png_structp png_ptr, png_infop info_ptr, png_bytep row) {
  * data as a PNG image to the buffer, using libpng.
  * returns a status struct containing error information, if any
  */
-status_t write_png_image(bitmap_t bitmap, buffer_t * buffer) {
+status_t write_png_image(bitmap_t bitmap, buffer_t* buffer) {
     // result status
     status_t result;
     // init buffer
diff --git a/saxbospiral/render_backends/png_backend.h b/saxbospiral/render_backends/png_backend.h
@@ -14,7 +14,7 @@ extern "C"{
  * data as a PNG image to the buffer, using libpng.
  * returns a status struct containing error information, if any
  */
-status_t write_png_image(bitmap_t bitmap, buffer_t * buffer);
+status_t write_png_image(bitmap_t bitmap, buffer_t* buffer);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/saxbospiral/saxbospiral.h b/saxbospiral/saxbospiral.h
@@ -35,8 +35,8 @@ version_hash_t version_hash(version_t version);
 // struct for storing the location of a DEBUG invocation
 typedef struct debug_t {
     size_t line;
-    char * file;
-    const char * function;
+    char* file;
+    const char* function;
 } debug_t;
 
 /*
@@ -101,7 +101,7 @@ typedef tuple_t vector_t;
 typedef tuple_t co_ord_t;
 
 typedef struct co_ord_array_t {
-    co_ord_t * items;
+    co_ord_t* items;
     size_t size;
 } co_ord_array_t;
 
@@ -112,7 +112,7 @@ typedef struct co_ord_cache_t {
 
 typedef struct spiral_t {
     uint64_t size; // count of lines
-    line_t * lines; // dynamic array of lines
+    line_t* lines; // dynamic array of lines
     co_ord_cache_t co_ord_cache; // co-ord cache for lines
     bool collides; // whether this spiral collides or not
     uint64_t collider; // the index of the line causing collision, if any
@@ -126,7 +126,7 @@ typedef struct spiral_t {
 } spiral_t;
 
 typedef struct buffer_t {
-    uint8_t * bytes;
+    uint8_t* bytes;
     size_t size;
 } buffer_t;
 
diff --git a/saxbospiral/serialise.c b/saxbospiral/serialise.c
@@ -3,6 +3,7 @@
 #warning "Please compile this code for a target with 64-bit words or greater."
 #endif
 
+#include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -64,7 +65,7 @@ static void dump_uint32_t(uint32_t value, buffer_t* buffer, size_t start_index)
  * whether the operation was successful or not and information about what went
  * wrong if it was not successful
  */
-serialise_result_t load_spiral(buffer_t buffer, spiral_t * spiral) {
+serialise_result_t load_spiral(buffer_t buffer, spiral_t* spiral) {
     serialise_result_t result; // build struct for returning success / failure
     // first, if header is too small for header + 1 line, then return early
     if(buffer.size < FILE_HEADER_SIZE + LINE_T_PACK_SIZE) {
@@ -74,7 +75,7 @@ serialise_result_t load_spiral(buffer_t buffer, spiral_t * spiral) {
         return result;
     }
     // check for magic number and return early if not right
-    if(strncmp((char *)buffer.bytes, "SAXBOSPIRAL", 11) != 0) {
+    if(strncmp((char*)buffer.bytes, "SAXBOSPIRAL", 11) != 0) {
         result.status.location = DEBUG; // catch location of error
         result.status.diagnostic = OPERATION_FAIL; // flag failure
         result.diagnostic = DESERIALISE_BAD_MAGIC_NUMBER; // failure reason
@@ -153,7 +154,7 @@ serialise_result_t load_spiral(buffer_t buffer, spiral_t * spiral) {
  * whether the operation was successful or not and information about what went
  * wrong if it was not successful
  */
-serialise_result_t dump_spiral(spiral_t spiral, buffer_t * buffer) {
+serialise_result_t dump_spiral(spiral_t spiral, buffer_t* buffer) {
     serialise_result_t result; // build struct for returning success / failure
     // populate buffer struct, base size on header + spiral size
     buffer->size = (FILE_HEADER_SIZE + (LINE_T_PACK_SIZE * spiral.size));
@@ -167,7 +168,7 @@ serialise_result_t dump_spiral(spiral_t spiral, buffer_t * buffer) {
     }
     // write first part of data header (magic number and version info)
     sprintf(
-        (char *)buffer->bytes, "SAXBOSPIRAL\n%c%c%c\n",
+        (char*)buffer->bytes, "SAXBOSPIRAL\n%c%c%c\n",
         VERSION.major, VERSION.minor, VERSION.patch
     );
     // write second part of data header (size, solved count and seconds fields)
diff --git a/saxbospiral/serialise.h b/saxbospiral/serialise.h
@@ -39,7 +39,7 @@ extern const size_t LINE_T_PACK_SIZE;
  * whether the operation was successful or not and information about what went
  * wrong if it was not successful
  */
-serialise_result_t load_spiral(buffer_t buffer, spiral_t * spiral);
+serialise_result_t load_spiral(buffer_t buffer, spiral_t* spiral);
 
 /*
  * given a spiral_t struct and a pointer to a blank buffer_t, serialise a binary
@@ -48,7 +48,7 @@ serialise_result_t load_spiral(buffer_t buffer, spiral_t * spiral);
  * whether the operation was successful or not and information about what went
  * wrong if it was not successful
  */
-serialise_result_t dump_spiral(spiral_t spiral, buffer_t * buffer);
+serialise_result_t dump_spiral(spiral_t spiral, buffer_t* buffer);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/saxbospiral/solve.c b/saxbospiral/solve.c
@@ -4,9 +4,9 @@
 #endif
 
 #include <stdbool.h>
+#include <stddef.h>
 #include <stdint.h>
 #include <stdio.h>
-#include <stdlib.h>
 
 #include "saxbospiral.h"
 #include "plot.h"
@@ -227,8 +227,10 @@ status_t resize_spiral(
         } else {
             /*
              * if we're on the top-most line and there's no collision
-             * this means we've finished! Return OPERATION_OK from function.
+             * this means we've finished! Set solved_count to this index+1
+             * Return OPERATION_OK from function.
              */
+            spiral->solved_count = index + 1;
             result.diagnostic = OPERATION_OK;
             return result;
         }
@@ -237,22 +239,40 @@ status_t resize_spiral(
 
 /*
  * given a pointer to a spiral spiral for which the length of all its lines are
- * not yet known and a perfection threshold (-1 for no perfection, or otherwise
- * the maximmum line length at which to allow aggressive optimisation) calculate
- * the length needed for each line in the spiral (to avoid line overlap) and
- * store these in a the spiral struct that is pointed to by the pointer
+ * not yet known, a perfection threshold (-1 for no perfection, or otherwise
+ * the maximmum line length at which to allow aggressive optimisation), the
+ * index of the highest line to plot to and a pointer to a callback function,
+ * calculate the length needed for each line in the spiral up to this index
+ * (to avoid line overlap) and store these in a the spiral struct that is
+ * pointed to by the pointer
+ * the function pointer can be NULL, if it is not then it will be called every
+ * time a new line of the spiral is solved. The function should be of return
+ * type void and take three arguments: a pointer to a spiral_t struct, an
+ * integer specifying the index of the latest solved line and an integer
+ * specifying the index of the highest line that will be solved.
  * returns a status struct (used for error information)
  */
-status_t plot_spiral(spiral_t* spiral, int perfection_threshold) {
+status_t plot_spiral(
+    spiral_t* spiral, int perfection_threshold, uint64_t max_line,
+    void(* progress_callback)(
+        spiral_t* spiral, uint64_t latest_line, uint64_t target_line
+    )
+) {
     // set up result status
     status_t result = {{0, 0, 0}, 0};
+    // get index of highest line to plot
+    uint64_t max_index = (max_line > spiral->size) ? spiral->size : max_line;
     // calculate the length of each line
-    for(size_t i = 0; i < spiral->size; i++) {
+    for(size_t i = 0; i < max_index; i++) {
         result = resize_spiral(spiral, i, 1, perfection_threshold);
         // catch and return error if any
         if(result.diagnostic != OPERATION_OK) {
             return result;
         }
+        // call callback if given
+        if(progress_callback != NULL) {
+            progress_callback(spiral, i, max_index);
+        }
     }
     // all ok
     result.diagnostic = OPERATION_OK;
diff --git a/saxbospiral/solve.h b/saxbospiral/solve.h
@@ -1,7 +1,7 @@
 #ifndef SAXBOPHONE_SAXBOSPIRAL_SOLVE_H
 #define SAXBOPHONE_SAXBOSPIRAL_SOLVE_H
 
-#include <stdbool.h>
+#include <stdint.h>
 
 #include "saxbospiral.h"
 
@@ -19,18 +19,30 @@ extern "C"{
  * returns a status struct (used for error information)
  */
 status_t resize_spiral(
-    spiral_t * spiral, size_t index, uint32_t length, int perfection_threshold
+    spiral_t* spiral, size_t index, uint32_t length, int perfection_threshold
 );
 
 /*
  * given a pointer to a spiral spiral for which the length of all its lines are
- * not yet known and a perfection threshold (-1 for no perfection, or otherwise
- * the maximmum line length at which to allow aggressive optimisation) calculate
- * the length needed for each line in the spiral (to avoid line overlap) and
- * store these in a the spiral struct that is pointed to by the pointer
+ * not yet known, a perfection threshold (-1 for no perfection, or otherwise
+ * the maximmum line length at which to allow aggressive optimisation), the
+ * index of the highest line to plot to and a pointer to a callback function,
+ * calculate the length needed for each line in the spiral up to this index
+ * (to avoid line overlap) and store these in a the spiral struct that is
+ * pointed to by the pointer
+ * the function pointer can be NULL, if it is not then it will be called every
+ * time a new line of the spiral is solved. The function should be of return
+ * type void and take three arguments: a pointer to a spiral_t struct, an
+ * integer specifying the index of the latest solved line and an integer
+ * specifying the index of the highest line that will be solved.
  * returns a status struct (used for error information)
  */
-status_t plot_spiral(spiral_t * spiral, int perfection_threshold);
+status_t plot_spiral(
+    spiral_t* spiral, int perfection_threshold, uint64_t max_line,
+    void(* progress_callback)(
+        spiral_t* spiral, uint64_t latest_line, uint64_t target_line
+    )
+);
 
 #ifdef __cplusplus
 } // extern "C"
diff --git a/sxp.c b/sxp.c
diff --git a/sxp.h b/sxp.h
diff --git a/tests.c b/tests.c
