Merge pull request #45 from saxbophone/develop

v0.11.0: New CLI

Author: saxbophone

.gitignore

@@ -29,9 +29,7 @@
 *.hex
 # Custom named executables
 sxp_test
-sxp_prepare
-sxp_generate
-sxp_render
+sxp
 
 # Debug files
 *.dSYM/
@@ -41,5 +39,6 @@ CMakeCache.txt
 CMakeFiles/
 Testing/
 Makefile
-*.cmake
+cmake_install.cmake
+CTestTestfile.cmake
 install_manifest.txt

CMakeLists.txt

@@ -2,7 +2,7 @@
 cmake_minimum_required(VERSION 3.0)
 enable_language(C CXX)
 
-project(saxbospiral VERSION 0.10.0 LANGUAGES C)
+project(saxbospiral VERSION 0.11.0 LANGUAGES C)
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(
@@ -36,8 +36,15 @@ if(NOT CMAKE_BUILD_TYPE EQUAL CMAKE_C_FLAGS_RELEASE)
     enable_c_compiler_flag_if_supported("-Werror")
 endif()
 
+# dependencies
+# add custom dependencies directory
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
+# libpng
 find_package(PNG REQUIRED)
 include_directories(${PNG_INCLUDE_DIR})
+# Argtable
+find_package(Argtable REQUIRED)
+include_directories(${ARGTABLE_INCLUDE_DIR})
 
 # C source files
 file(
@@ -55,14 +62,10 @@ add_library(saxbospiral ${LIB_SAXBOSPIRAL_SOURCES})
 # Link libsaxbospiral with libpng so we get libpng symbols
 target_link_libraries(saxbospiral ${PNG_LIBRARY})
 
-add_executable(sxp_prepare prepare.c)
-add_executable(sxp_generate generate.c)
-add_executable(sxp_render render.c)
+add_executable(sxp sxp.c)
 add_executable(sxp_test tests.c)
 
-target_link_libraries(sxp_prepare saxbospiral ${PNG_LIBRARY})
-target_link_libraries(sxp_generate saxbospiral ${PNG_LIBRARY})
-target_link_libraries(sxp_render saxbospiral ${PNG_LIBRARY})
+target_link_libraries(sxp saxbospiral ${PNG_LIBRARY} ${ARGTABLE_LIBRARY})
 target_link_libraries(sxp_test saxbospiral ${PNG_LIBRARY})
 
 install(
@@ -82,13 +85,7 @@ install(
     DESTINATION include/saxbospiral/render_backends
 )
 
-install(
-    PROGRAMS
-    sxp_prepare
-    sxp_generate
-    sxp_render
-    DESTINATION bin
-)
+install(PROGRAMS sxp DESTINATION bin)
 
 enable_testing()
 add_test(unit_tests sxp_test)
@@ -98,12 +95,12 @@ find_program(COMMAND_INTERPRETER bash)
 if(COMMAND_INTERPRETER)
     add_test(
         NAME func_test COMMAND ${COMMAND_INTERPRETER}
-        # each script needs to know the path to each executable it runs
-        "func_test.sh" sxp_prepare sxp_generate sxp_render "saxbospiral ${SAXBOSPIRAL_VERSION_STRING}"
+        # each script needs to know the path to the sxp cli executable
+        "func_test.sh" sxp "saxbospiral ${SAXBOSPIRAL_VERSION_STRING}"
     )
     add_custom_target(
         build_logo ${COMMAND_INTERPRETER}
-        "build_logo.sh" sxp_prepare sxp_generate sxp_render "saxbospiral.png" "saxbospiral ${SAXBOSPIRAL_VERSION_STRING}"
+        "build_logo.sh" sxp "saxbospiral.png" "saxbospiral ${SAXBOSPIRAL_VERSION_STRING}"
     )
 else()
     # warn about skipping of functional test script

build_logo.sh

@@ -1,14 +1,13 @@
 #!/bin/bash
 # 
 # Script for updating the project logo
-# The paths of the prepare, generate and render commands are
-# passed as the first 3 arguments. The 4th argument is the
-# file to write the PNG output to and the 5th is the message
-# to use for the logo data (of format "saxbospiral vX.Y.Z")
+# The first argument is the path to the sxp cli program.
+# The second argument is the file to write the PNG output to.
+# The third is the message to use for the logo data
+# (of format "saxbospiral vX.Y.Z").
 # 
 echo "Generating logo";
-echo -n "$5" > temp.hex && \
-./"$1" temp.hex temp.sxp && \
-./"$2" temp.sxp && \
-./"$3" temp.sxp "$4" && \
+echo -n "$3" > temp.hex && \
+./"$1" -pg -i temp.hex -o temp.sxp && \
+./"$1" -r -i temp.sxp -o "$2"
 rm temp.hex temp.sxp;

cmake/Modules/FindArgtable.cmake

@@ -0,0 +1,44 @@
+# https://raw.githubusercontent.com/cinemast/libjson-rpc-cpp/master/cmake/FindArgtable.cmake
+# - Try to find ARGTABLE
+# Once done this will define
+#
+#  ARGTABLE_FOUND - system has ARGTABLE
+#  ARGTABLE_INCLUDE_DIRS - the ARGTABLE include directory
+#  ARGTABLE_LIBRARIES - Link these to use ARGTABLE
+
+find_path(
+    ARGTABLE_INCLUDE_DIR
+    NAMES argtable2.h
+    DOC "argtable include dir"
+)
+
+find_library(
+    ARGTABLE_LIBRARY
+    NAMES argtable2
+    DOC "argtable library"
+)
+
+set(ARGTABLE_INCLUDE_DIRS ${ARGTABLE_INCLUDE_DIR})
+set(ARGTABLE_LIBRARIES ${ARGTABLE_LIBRARY})
+
+# debug library on windows
+# same naming convention as in qt (appending debug library with d)
+# boost is using the same "hack" as us with "optimized" and "debug"
+if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
+    find_library(
+        ARGTABLE_LIBRARY_DEBUG
+        NAMES argtable2d
+        DOC "argtable debug library"
+    )
+
+    set(ARGTABLE_LIBRARIES optimized ${ARGTABLE_LIBRARIES} debug ${ARGTABLE_LIBRARY_DEBUG})
+
+endif()
+
+# handle the QUIETLY and REQUIRED arguments and set JSONCPP_FOUND to TRUE
+# if all listed variables are TRUE, hide their existence from configuration view
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(
+    argtable DEFAULT_MSG ARGTABLE_INCLUDE_DIR ARGTABLE_LIBRARY
+)
+mark_as_advanced(ARGTABLE_INCLUDE_DIR ARGTABLE_LIBRARY)

func_test.sh

@@ -2,10 +2,9 @@
 # 
 # Functional test script.
 # Generates a new logo and compares with the current one.
-# The paths of the prepare, generate and render commands are
-# passed as the first 3 arguments. The 4th argument is the
-# message to use for the file (see build_logo.sh)
+# The first argument is the path to the sxp cli program.
+# The second argument is the message to use for the file (see build_logo.sh)
 # 
-./build_logo.sh "$1" "$2" "$3" "test_saxbospiral.png" "$4" && \
+./build_logo.sh "$1" "test_saxbospiral.png" "$2" && \
 diff "saxbospiral.png" "test_saxbospiral.png" && \
 rm "test_saxbospiral.png";