Merge pull request #79 from saxbophone/josh/58-progress-callback

Add optional callback function pointer argument to plot_spiral()

Author: saxbophone

saxbospiral/solve.c

@@ -240,14 +240,23 @@ status_t resize_spiral(
 /*
  * given a pointer to a spiral spiral for which the length of all its lines are
  * not yet known, a perfection threshold (-1 for no perfection, or otherwise
- * the maximmum line length at which to allow aggressive optimisation) and the
- * index of the highest line to plot to, 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 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, uint64_t max_line
+    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};
@@ -260,6 +269,10 @@ status_t plot_spiral(
         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;

saxbospiral/solve.h

@@ -25,14 +25,23 @@ status_t resize_spiral(
 /*
  * given a pointer to a spiral spiral for which the length of all its lines are
  * not yet known, a perfection threshold (-1 for no perfection, or otherwise
- * the maximmum line length at which to allow aggressive optimisation) and the
- * index of the highest line to plot to, 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 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, uint64_t max_line
+    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

sxp.c

@@ -213,7 +213,7 @@ bool run(
             (uint64_t)total_lines : lines_to_plot
         );
         // we must plot all lines from spiral file
-        if(handle_error(plot_spiral(&spiral, perfection, lines_to_plot))) {
+        if(handle_error(plot_spiral(&spiral, perfection, lines_to_plot, NULL))) {
             // handle errors
             return false;
         }

tests.c

@@ -204,7 +204,7 @@ bool test_plot_spiral() {
     }
 
     // call plot_spiral on spiral
-    plot_spiral(&spiral, 1, 16);
+    plot_spiral(&spiral, 1, 16, NULL);
 
     // check solved count
     if(spiral.solved_count != expected.solved_count) {
@@ -248,7 +248,7 @@ bool test_plot_spiral_partial() {
     }
 
     // call plot_spiral on spiral, with instruction to only plot up to line 9
-    plot_spiral(&spiral, 1, 9);
+    plot_spiral(&spiral, 1, 9, NULL);
 
     // check solved count
     if(spiral.solved_count != expected.solved_count) {