Merge pull request #67 from saxbophone/develop

Version 0.12.1

Author: saxbophone

CMakeLists.txt

@@ -1,8 +1,7 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
-enable_language(C CXX)
 
-project(saxbospiral VERSION 0.12.0 LANGUAGES C)
+project(saxbospiral VERSION 0.12.1 LANGUAGES C)
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(
@@ -18,9 +17,9 @@ add_definitions(-DSAXBOSPIRAL_VERSION_MINOR=${PROJECT_VERSION_MINOR})
 add_definitions(-DSAXBOSPIRAL_VERSION_PATCH=${PROJECT_VERSION_PATCH})
 add_definitions(-DSAXBOSPIRAL_VERSION_STRING=${SAXBOSPIRAL_ESCAPED_VERSION_STRING})
 
+# used for enabling additional compiler options if supported
 include(CheckCCompilerFlag)
 
-# used for enabling additional compiler options if supported
 function(enable_c_compiler_flag_if_supported flag)
     string(FIND "${CMAKE_C_FLAGS}" "${flag}" flag_already_set)
     if(flag_already_set EQUAL -1)
@@ -32,7 +31,14 @@ function(enable_c_compiler_flag_if_supported flag)
 endfunction()
 
 # enable extra flags (warnings) if we're not in release mode
-if(NOT CMAKE_BUILD_TYPE EQUAL CMAKE_C_FLAGS_RELEASE)
+if(NOT CMAKE_BUILD_TYPE STREQUAL "Release")
+    # enable all warnings about 'questionable constructs'
+    enable_c_compiler_flag_if_supported("-Wall")
+    # issue 'pedantic' warnings for strict ISO compliance
+    enable_c_compiler_flag_if_supported("-Wpedantic")
+    # enable 'extra' strict warnings
+    enable_c_compiler_flag_if_supported("-Wextra")
+    # convert all warnings into errors
     enable_c_compiler_flag_if_supported("-Werror")
 endif()
 

README.md

@@ -8,7 +8,7 @@ Experimental generation of 2D spiralling lines based on input binary data
 
 For the library, you will need:
 
-- A compiler that can compile C99 code
+- A compiler that can compile ISO C99 code
 - [Cmake](https://cmake.org/) - v3.0 or newer
 - [libpng](http://www.libpng.org/pub/png/libpng.html) - (this often comes preinstalled with many modern unix-like systems)
 
@@ -18,11 +18,11 @@ For the included CLI program, you will also need:
 
 - [Argtable 2](http://argtable.sourceforge.net/) - must use v2, v1 and v3 will not work
 
-### Note:
+> ### Note:
 
-These commands are for unix-like systems, without an IDE or other build system besides CMake. If building for a different system, or within an IDE or other environment, consult your IDE/System documentation on how to build CMake projects.
+> These commands are for unix-like systems, without an IDE or other build system besides CMake. If building for a different system, or within an IDE or other environment, consult your IDE/System documentation on how to build CMake projects.
 
-Additionally, it is of worth noting that this library has only been thoroughly tested and developed on Ubuntu GNU/Linux, although every effort has been made to make it as cross-platform as possible. It should compile under any POSIX-compliant system with the correct additional dependencies listed. **v0.8** is known to successfully cross-compile from Ubuntu to Windows (via [cygwin](https://www.cygwin.com/)) and Max OSX (using a locally-built compiler toolchain provided via [OSXCross](https://github.com/tpoechtrager/osxcross). It is highly likely that all other versions cross-compile as well (but I haven't yet verified this).
+> Additionally, it is of worth noting that this library has only been thoroughly tested and developed on **Ubuntu GNU/Linux** with **GCC v5.4.0**, although every effort has been made to make it as cross-platform as possible (including reasonably strict **ISO C 99** compliance). It should compile under any POSIX-compliant system with the correct additional dependencies listed. **v0.8** is known to successfully cross-compile from Ubuntu to Windows (via [cygwin](https://www.cygwin.com/)) and Max OSX (using a locally-built compiler toolchain provided via [OSXCross](https://github.com/tpoechtrager/osxcross). It is highly likely that all other versions cross-compile as well (but I haven't yet verified this).
 
 ## Basic Build
 

build_logo.sh

@@ -8,4 +8,5 @@
 # 
 echo "Generating logo";
 echo -n "$3" > temp.hex && \
-./"$1" -pgr -i temp.hex -o "$2";
+./"$1" -pgr -i temp.hex -o "$2" && \
+rm temp.hex;

saxbospiral.png

@@ -35,7 +35,7 @@ spiral_points(
     size_t start, size_t end
 ) {
     // prepare result status
-    status_t result = {};
+    status_t result = {0};
     // the amount of space needed is the sum of all line lengths + 1 for end
     size_t size = sum_lines(spiral, start, end) + 1;
     // allocate memory
@@ -82,7 +82,7 @@ spiral_points(
 status_t
 cache_spiral_points(spiral_t * spiral, size_t limit) {
     // prepare result status
-    status_t result = {};
+    status_t result = {0};
     // the amount of space needed is the sum of all line lengths + 1 for end
     size_t size = sum_lines(*spiral, 0, limit) + 1;
     // allocate / reallocate memory
@@ -126,7 +126,7 @@ cache_spiral_points(spiral_t * spiral, size_t limit) {
         spiral->co_ord_cache.co_ords.items[0] = current;
     }
     // calculate the missing co-ords
-    co_ord_array_t missing= {};
+    co_ord_array_t missing= {0};
     status_t calculate_result = spiral_points(
         *spiral, &missing, current, smallest, limit
     );

saxbospiral/plot.c

@@ -58,22 +58,18 @@ get_bounds(spiral_t spiral, co_ord_t * bounds) {
 status_t
 render_spiral(spiral_t spiral, bitmap_t * image) {
     // create result status struct
-    status_t result = {};
+    status_t result = {0};
     // plot co-ords of spiral into it's cache
     cache_spiral_points(&spiral, spiral.size);
     // get the min and max bounds of the spiral's co-ords
-    co_ord_t bounds[2] = {};
+    co_ord_t bounds[2] = {0};
     get_bounds(spiral, bounds);
     // get the normalisation vector needed to make all values unsigned
     tuple_t normalisation_vector = {
         .x = -bounds[0].x,
         .y = -bounds[0].y,
     };
-    // get co-ords of top left and bottom right corners, as unsigned
-    co_ord_t top_left = {
-        .x = 0,
-        .y = 0,
-    };
+    // get co-ords of bottom right corner, as unsigned
     co_ord_t bottom_right = {
         .x = bounds[1].x + normalisation_vector.x,
         .y = bounds[1].y + normalisation_vector.y,
@@ -112,7 +108,7 @@ render_spiral(spiral_t spiral, bitmap_t * image) {
         // get current direction
         vector_t direction = VECTOR_DIRECTIONS[spiral.lines[i].direction];
         // make as many jumps in this direction as this lines length
-        for(uint64_t j = 0; j < (spiral.lines[i].length * 2) + 1; j++) {
+        for(uint64_t j = 0; j < (spiral.lines[i].length * 2U) + 1U; j++) {
             // get output co-ords
             tuple_item_t x_pos = current.x + (normalisation_vector.x * 2) + 1;
             tuple_item_t y_pos = current.y + (normalisation_vector.y * 2) + 1;
@@ -121,7 +117,7 @@ render_spiral(spiral_t spiral, bitmap_t * image) {
                 // flip the y-axis otherwise they appear vertically mirrored
                 image->pixels[x_pos][image->height - 1 - y_pos] = true;
             }
-            if(j != (spiral.lines[i].length * 2)) {
+            if(j != (spiral.lines[i].length * 2U)) {
                 // if we're not on the last line, advance the marker along
                 current.x += direction.x;
                 current.y += direction.y;

saxbospiral/render.c

@@ -34,8 +34,13 @@ buffer_write_data(png_structp png_ptr, png_bytep data, png_size_t length) {
     p->size += length;
 }
 
+// disable GCC warning about the unused parameter, as this is a dummy function
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wunused-parameter"
 // dummy function for unecessary flush function
 void dummy_png_flush(png_structp png_ptr) {}
+// re-enable all warnings
+#pragma GCC diagnostic pop
 
 // simple libpng cleanup function - used mainly for freeing memory
 void

saxbospiral/render_backends/png_backend.c

@@ -110,6 +110,8 @@ typedef struct co_ord_cache_t {
 } co_ord_cache_t;
 
 typedef struct spiral_t {
+    // TODO: Change type of this to int64_t
+    //       Then, remove typecast in solve.c, in function spiral_collides()
     size_t size;
     line_t * lines;
     co_ord_cache_t co_ord_cache;

saxbospiral/saxbospiral.h

@@ -95,7 +95,8 @@ load_spiral(buffer_t buffer, spiral_t * spiral) {
          * bit mask and shift 3 bytes to left
          */
         spiral->lines[i].length = (
-            buffer.bytes[FILE_HEADER_SIZE + (i * LINE_T_PACK_SIZE)] & 0b00111111
+            buffer.bytes[FILE_HEADER_SIZE + (i * LINE_T_PACK_SIZE)]
+            & 0x3f // <= binary value is 0b00111111
         ) << 24;
         // handle remaining 3 bytes in loop
         for(uint8_t j = 0; j < 3; j++) {

saxbospiral/serialise.c

@@ -40,7 +40,7 @@ spiral_collides(spiral_t spiral, size_t index) {
         int64_t ttl = spiral.lines[line_count].length + 1; // ttl of line
         size_t last_co_ord = spiral.co_ord_cache.co_ords.size;
         line_t last_line = spiral.lines[index];
-        size_t start_of_last_line = (last_co_ord - last_line.length) - 1;
+        int64_t start_of_last_line = (last_co_ord - last_line.length) - 1;
         // check the co-ords of the last line segment against all the others
         for(int64_t i = 0; i < start_of_last_line; i++) {
             for(size_t j = start_of_last_line; j < last_co_ord; j++) {
@@ -69,7 +69,7 @@ spiral_collides(spiral_t spiral, size_t index) {
              * before the last one (these two lines can never collide with the
              * last and can be safely ignored, for a small performance increase)
              */
-            if(line_count == (spiral.size - 2 - 1)) { // -1 for zero-index
+            if(line_count == ((int64_t)spiral.size - 2 - 1)) { // -1 for zero-index
                 break;
             }
         }
@@ -122,15 +122,14 @@ suggest_resize(spiral_t spiral, size_t index, int perfection_threshold) {
             return spiral.lines[index - 1].length + 1;
         }
         // create variables to store the start and end co-ords of these lines
-        co_ord_t pa, pb, ra, rb;
+        co_ord_t pa, ra, rb;
         /*
          * We need to grab the start and end co-ords of the line previous to the
          * colliding line, and the rigid line that it collided with.
          */
         size_t p_index = sum_lines(spiral, 0, index - 1);
         size_t r_index = sum_lines(spiral, 0, spiral.collides);
         pa = spiral.co_ord_cache.co_ords.items[p_index];
-        pb = spiral.co_ord_cache.co_ords.items[p_index + p.length];
         ra = spiral.co_ord_cache.co_ords.items[r_index];
         rb = spiral.co_ord_cache.co_ords.items[r_index + r.length];
         /*
@@ -185,7 +184,7 @@ resize_spiral(
      * state of which line is being resized, and what size it should be.
      */
     // set result status
-    status_t result = {};
+    status_t result = {0};
     size_t current_index = index;
     length_t current_length = length;
     while(true) {
@@ -245,7 +244,7 @@ resize_spiral(
 status_t
 plot_spiral(spiral_t * spiral, int perfection_threshold) {
     // set up result status
-    status_t result = {};
+    status_t result = {0};
     // calculate the length of each line
     for(size_t i = 0; i < spiral->size; i++) {
         result = resize_spiral(spiral, i, 1, perfection_threshold);