Merge pull request #148 from saxbophone/develop

v0.24.0 - Rename

Author: saxbophone

.travis.yml

@@ -12,8 +12,8 @@ compiler:
 # different C Standard versions - test on C99 and C11
 env:
   matrix:
-    - LIBSAXBOSPIRAL_C_STANDARD=99
-    - LIBSAXBOSPIRAL_C_STANDARD=11
+    - LIBSXBP_C_STANDARD=99
+    - LIBSXBP_C_STANDARD=11
 matrix:
   # exclude gcc on osx as this always points to clang
   exclude:

CLA_INDIVIDUAL.md

@@ -1,14 +1,14 @@
-### libsaxbospiral Individual Contributor Assignment Agreement
+### libsxbp Individual Contributor Assignment Agreement
 
-Thank you for your interest in contributing to libsaxbospiral ("We" or "Us").
+Thank you for your interest in contributing to libsxbp ("We" or "Us").
 
-This contributor agreement ("Agreement") documents the rights granted by contributors to Us. To make this document effective, please sign it and send it to Us by email, following the instructions at [https://github.com/saxbophone/libsaxbospiral/blob/master/CONTRIBUTING.md](https://github.com/saxbophone/libsaxbospiral/blob/master/CONTRIBUTING.md). This is a legally binding document, so please read it carefully before agreeing to it. The Agreement may cover more than one software project managed by Us.
+This contributor agreement ("Agreement") documents the rights granted by contributors to Us. To make this document effective, please sign it and send it to Us by email, following the instructions at [https://github.com/saxbophone/libsxbp/blob/master/CONTRIBUTING.md](https://github.com/saxbophone/libsxbp/blob/master/CONTRIBUTING.md). This is a legally binding document, so please read it carefully before agreeing to it. The Agreement may cover more than one software project managed by Us.
 
 #### 1. Definitions
 
 "You" means the individual who Submits a Contribution to Us.
 
-"Contribution" means any work of authorship that is Submitted by You to Us in which You own or assert ownership of the Copyright. If You do not own the Copyright in the entire work of authorship, please follow the instructions in [https://github.com/saxbophone/libsaxbospiral/blob/master/CONTRIBUTING.md](https://github.com/saxbophone/libsaxbospiral/blob/master/CONTRIBUTING.md).
+"Contribution" means any work of authorship that is Submitted by You to Us in which You own or assert ownership of the Copyright. If You do not own the Copyright in the entire work of authorship, please follow the instructions in [https://github.com/saxbophone/libsxbp/blob/master/CONTRIBUTING.md](https://github.com/saxbophone/libsxbp/blob/master/CONTRIBUTING.md).
 
 "Copyright" means all rights protecting works of authorship owned or controlled by You, including copyright, moral and neighboring rights, as appropriate, for the full term of their existence including any extensions by You.
 
@@ -62,7 +62,7 @@ You confirm that:
 
 (c) The grant of rights under Section 2 does not violate any grant of rights which You have made to third parties, including Your employer. If You are an employee, You have had Your employer approve this Agreement or sign the Entity version of this document. If You are less than eighteen years old, please have Your parents or guardian sign the Agreement.
 
-(d) You have followed the instructions in [https://github.com/saxbophone/libsaxbospiral/blob/master/CONTRIBUTING.md](https://github.com/saxbophone/libsaxbospiral/blob/master/CONTRIBUTING.md), if You do not own the Copyright in the entire work of authorship Submitted.
+(d) You have followed the instructions in [https://github.com/saxbophone/libsxbp/blob/master/CONTRIBUTING.md](https://github.com/saxbophone/libsxbp/blob/master/CONTRIBUTING.md), if You do not own the Copyright in the entire work of authorship Submitted.
 
 #### 4. Disclaimer
 

CMakeLists.txt

@@ -1,7 +1,7 @@
-# This source file forms part of libsaxbospiral, a library which generates
+# This source file forms part of libsxbp, a library which generates
 # experimental 2D spiral-like shapes based on input binary data.
 #
-# This is the CMake build file for libsaxbospiral.
+# This is the CMake build file for libsxbp.
 # It requires CMake v3.0 or greater.
 #
 #
@@ -23,45 +23,45 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
 
-project(libsaxbospiral VERSION 0.23.0 LANGUAGES C)
+project(sxbp VERSION 0.24.0 LANGUAGES C)
 
 # set default C standard to use (C99) if not already set
-if(NOT DEFINED SAXBOSPIRAL_C_STANDARD)
-    set(SAXBOSPIRAL_C_STANDARD "99")
+if(NOT DEFINED LIBSXBP_C_STANDARD)
+    set(LIBSXBP_C_STANDARD "99")
 endif()
-# if env variable LIBSAXBOSPIRAL_C_STANDARD is set and valid, override version
-if(DEFINED ENV{LIBSAXBOSPIRAL_C_STANDARD})
+# if env variable LIBSXBP_C_STANDARD is set and valid, override version
+if(DEFINED ENV{LIBSXBP_C_STANDARD})
     # not a very robust regex but ok for most purposes
-    if("$ENV{LIBSAXBOSPIRAL_C_STANDARD}" MATCHES "(99|11)")
-        set(SAXBOSPIRAL_C_STANDARD "$ENV{LIBSAXBOSPIRAL_C_STANDARD}")
+    if("$ENV{LIBSXBP_C_STANDARD}" MATCHES "(99|11)")
+        set(LIBSXBP_C_STANDARD "$ENV{LIBSXBP_C_STANDARD}")
     endif()
 endif()
-message(STATUS "C Standard set to C${SAXBOSPIRAL_C_STANDARD}")
-set(CMAKE_C_STANDARD ${SAXBOSPIRAL_C_STANDARD})
+message(STATUS "C Standard set to C${LIBSXBP_C_STANDARD}")
+set(CMAKE_C_STANDARD ${LIBSXBP_C_STANDARD})
 set(CMAKE_C_STANDARD_REQUIRED ON)
 
 set(
-    SAXBOSPIRAL_VERSION_STRING
+    LIBSXBP_VERSION_STRING
     "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}"
 )
-set(SAXBOSPIRAL_ESCAPED_VERSION_STRING "\"${SAXBOSPIRAL_VERSION_STRING}\"")
+set(LIBSXBP_ESCAPED_VERSION_STRING "\"${LIBSXBP_VERSION_STRING}\"")
 # end basic metadata
 
 # this is a 64-bit project, so check now to make sure we're 64-bit, issue warning if not
 if(CMAKE_SIZEOF_VOID_P LESS 8)
     message(
         WARNING
         "It looks like this system's architecture is not at least 64-bit.\n"
-        "libsaxbospiral requires a system with an architecture of at least 64 bits!\n"
+        "libsxbp requires a system with an architecture of at least 64 bits!\n"
         "We'll continue trying to compile anyway, be sure to run the unit tests after."
     )
 endif()
 
 # pass in version of library as preprocessor definitions
-add_definitions(-DSAXBOSPIRAL_VERSION_MAJOR=${PROJECT_VERSION_MAJOR})
-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})
+add_definitions(-DLIBSXBP_VERSION_MAJOR=${PROJECT_VERSION_MAJOR})
+add_definitions(-DLIBSXBP_VERSION_MINOR=${PROJECT_VERSION_MINOR})
+add_definitions(-DLIBSXBP_VERSION_PATCH=${PROJECT_VERSION_PATCH})
+add_definitions(-DLIBSXBP_VERSION_STRING=${LIBSXBP_ESCAPED_VERSION_STRING})
 
 # used for enabling additional compiler options if supported
 include(CheckCCompilerFlag)
@@ -94,17 +94,17 @@ endif()
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
 # libpng
 # work out whether we have or have not requested PNG support, or don't care (default)
-if(NOT DEFINED SAXBOSPIRAL_PNG_SUPPORT)
+if(NOT DEFINED LIBSXBP_PNG_SUPPORT)
     # try and find libpng v1.x, but don't fail if we can't
     message(STATUS "PNG output support will be enabled if possible")
     find_package(PNG 1 EXACT)
-    # set SAXBOSPIRAL_PNG_SUPPORT based on value of PNG_FOUND
+    # set SXBP_PNG_SUPPORT based on value of PNG_FOUND
     if(PNG_FOUND)
-        set(SAXBOSPIRAL_PNG_SUPPORT ON)
+        set(LIBSXBP_PNG_SUPPORT ON)
     else()
-        set(SAXBOSPIRAL_PNG_SUPPORT OFF)
+        set(LIBSXBP_PNG_SUPPORT OFF)
     endif()
-elseif(SAXBOSPIRAL_PNG_SUPPORT)
+elseif(LIBSXBP_PNG_SUPPORT)
     # find libpng v1.x and fail the build if we can't
     message(STATUS "PNG output support explicitly enabled")
     find_package(PNG 1 EXACT REQUIRED)
@@ -115,10 +115,10 @@ else()
 endif()
 
 # include libpng directories and add feature test macro if support is enabled
-if(SAXBOSPIRAL_PNG_SUPPORT)
+if(LIBSXBP_PNG_SUPPORT)
     include_directories(${PNG_INCLUDE_DIR})
     # feature test macro
-    add_definitions(-DSAXBOSPIRAL_PNG_SUPPORT)
+    add_definitions(-DLIBSXBP_PNG_SUPPORT)
     # issue message
     message(STATUS "PNG output support enabled")
 else()
@@ -129,70 +129,70 @@ endif()
 
 # C source files
 file(
-    GLOB LIB_SAXBOSPIRAL_SOURCES
-    "saxbospiral/*.c" "saxbospiral/render_backends/*.c"
+    GLOB LIBSXBP_SOURCES
+    "sxbp/*.c" "sxbp/render_backends/*.c"
 )
 # Header files
-file(GLOB LIB_SAXBOSPIRAL_HEADERS "saxbospiral/*.h")
+file(GLOB LIBSXBP_HEADERS "sxbp/*.h")
 # Header files for render_backends subdirectory
 file(
-    GLOB LIB_SAXBOSPIRAL_RENDER_BACKENDS_HEADERS
-    "saxbospiral/render_backends/*.h"
+    GLOB LIBSXBP_RENDER_BACKENDS_HEADERS
+    "sxbp/render_backends/*.h"
 )
-add_library(saxbospiral ${LIB_SAXBOSPIRAL_SOURCES})
+add_library(sxbp ${LIBSXBP_SOURCES})
 # set up version for library objects
 set_target_properties(
-    saxbospiral PROPERTIES VERSION ${SAXBOSPIRAL_VERSION_STRING}
+    sxbp PROPERTIES VERSION ${LIBSXBP_VERSION_STRING}
     SOVERSION ${PROJECT_VERSION_MAJOR}
 )
-# link libsaxbospiral with C math library
-target_link_libraries(saxbospiral m)
-# Link libsaxbospiral with libpng so we get libpng symbols (if support enabled)
-if(SAXBOSPIRAL_PNG_SUPPORT)
-    target_link_libraries(saxbospiral ${PNG_LIBRARY})
+# link libsxbp with C math library
+target_link_libraries(sxbp m)
+# Link libsxbp with libpng so we get libpng symbols (if support enabled)
+if(SXBP_PNG_SUPPORT)
+    target_link_libraries(sxbp ${PNG_LIBRARY})
 endif()
 
 add_executable(sxp_test tests.c)
 
-target_link_libraries(sxp_test saxbospiral)
+target_link_libraries(sxp_test sxbp)
 
 install(
-    TARGETS saxbospiral
+    TARGETS sxbp
     ARCHIVE DESTINATION lib
     LIBRARY DESTINATION lib
     RUNTIME DESTINATION bin
 )
 
 # Generate rough (nearest major) version-dependent header installation folder
 set(
-    LIBSAXBOSPIRAL_ROUGH_HEADER_DESTINATION
-    "saxbospiral-${PROJECT_VERSION_MAJOR}"
+    LIBSXBP_ROUGH_HEADER_DESTINATION
+    "sxbp-${PROJECT_VERSION_MAJOR}"
 )
 # Generate precise (major and minor) version-dependent header installation folder
 set(
-    LIBSAXBOSPIRAL_PRECISE_HEADER_DESTINATION
-    "saxbospiral-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+    LIBSXBP_PRECISE_HEADER_DESTINATION
+    "sxbp-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
 )
 
 # Install main library header files, both to rough and precise install locations
 install(
-    FILES ${LIB_SAXBOSPIRAL_HEADERS}
-    DESTINATION "include/${LIBSAXBOSPIRAL_ROUGH_HEADER_DESTINATION}"
+    FILES ${LIBSXBP_HEADERS}
+    DESTINATION "include/${LIBSXBP_ROUGH_HEADER_DESTINATION}"
 )
 # Install render_backends header files
 install(
-    FILES ${LIB_SAXBOSPIRAL_RENDER_BACKENDS_HEADERS}
-    DESTINATION "include/${LIBSAXBOSPIRAL_ROUGH_HEADER_DESTINATION}/render_backends"
+    FILES ${LIBSXBP_RENDER_BACKENDS_HEADERS}
+    DESTINATION "include/${LIBSXBP_ROUGH_HEADER_DESTINATION}/render_backends"
 )
 
 install(
-    FILES ${LIB_SAXBOSPIRAL_HEADERS}
-    DESTINATION "include/${LIBSAXBOSPIRAL_PRECISE_HEADER_DESTINATION}"
+    FILES ${LIBSXBP_HEADERS}
+    DESTINATION "include/${LIBSXBP_PRECISE_HEADER_DESTINATION}"
 )
 # Install render_backends header files
 install(
-    FILES ${LIB_SAXBOSPIRAL_RENDER_BACKENDS_HEADERS}
-    DESTINATION "include/${LIBSAXBOSPIRAL_PRECISE_HEADER_DESTINATION}/render_backends"
+    FILES ${LIBSXBP_RENDER_BACKENDS_HEADERS}
+    DESTINATION "include/${LIBSXBP_PRECISE_HEADER_DESTINATION}/render_backends"
 )
 
 enable_testing()

CONTRIBUTING.md

@@ -1,8 +1,8 @@
-# libsaxbospiral - Contributing
+# libsxbp - Contributing
 
-Thanks for considering contributing to libsaxbospiral!
+Thanks for considering contributing to libsxbp!
 
-To get started, [sign the Contributor License Agreement](https://www.clahub.com/agreements/saxbophone/libsaxbospiral).
+To get started, [sign the Contributor License Agreement](https://www.clahub.com/agreements/saxbophone/libsxbp).
 
 > [A copy of the CLA](CLA_INDIVIDUAL.md) is also available in this repository.
 
@@ -12,7 +12,7 @@ Here are some tips and general info about contributing to this project. Followin
 
 Before you contribute, check the work you're about to do fulfils one of these criteria:
 
-1. Implements a feature represented by an accepted issue in the project's [Github issue tracker](https://github.com/saxbophone/libsaxbospiral/issues)
+1. Implements a feature represented by an accepted issue in the project's [Github issue tracker](https://github.com/saxbophone/libsxbp/issues)
 2. Fixes a bug you discovered (preferably an issue should be created too, but for small or critical bugs, this may not be needed).
 
 Please also check that the work is not already being undertaken by someone else.
@@ -32,6 +32,6 @@ In addition, please make sure:
 
 ## Testing
 
-The unit tests for libsaxbospiral currently all reside in one C source file, `tests.c`. This isn't ideal, and I'm planning to clean these up at some point. Build and run the unit tests when you first pull down the code, rebuild and run them again when you've made your changes. Changes adding larger pieces of functionality will likely have additional tests requested for them, or an offer made to write the tests for them.
+The unit tests for libsxbp currently all reside in one C source file, `tests.c`. This isn't ideal, and I'm planning to clean these up at some point. Build and run the unit tests when you first pull down the code, rebuild and run them again when you've made your changes. Changes adding larger pieces of functionality will likely have additional tests requested for them, or an offer made to write the tests for them.
 
 Pull requests also go through [Travis CI](https://travis-ci.org/) for automated testing.