Improve test framework and tests

.github/workflows/ci.yml

@@ -17,6 +17,11 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
+    - name: Install System Tools
+      if: runner.os == 'Linux'
+      shell: bash
+      run: sudo apt install -y valgrind
+
     - name: Create Build Environment
       run: cmake -E make_directory ${{runner.workspace}}/build
 
@@ -47,10 +52,16 @@ jobs:
       shell: bash
       run: ctest -C $BUILD_TYPE
 
+    - name: Memory Check
+      if: runner.os == 'Linux'
+      working-directory: ${{runner.workspace}}/build
+      shell: bash
+      run: cmake --build . --target memcheck --config $BUILD_TYPE
+
     - name: Install
       working-directory: ${{runner.workspace}}/build
       shell: bash
-      run: cmake --build . --target install
+      run: cmake --build . --target install --config $BUILD_TYPE
 
     - name: Test CMake Installation
       shell: bash
@@ -62,8 +73,8 @@ jobs:
         else
             cmake -DCMAKE_PREFIX_PATH=~/tinyspline ..
         fi
-        cmake --build .
-        ctest
+        cmake --build . --config $BUILD_TYPE
+        ctest -C $BUILD_TYPE
 
     - name: Test Pkg-config Installation
       shell: bash

examples/cxx/quickstart.cpp

@@ -10,31 +10,31 @@ int main(int argc, char **argv)
 
 	// Setup control points.
 	std::vector<tinyspline::real> ctrlp = spline.controlPoints();
-	ctrlp[0]  = -1.75; // x0
-	ctrlp[1]  = -1.0;  // y0
-	ctrlp[2]  = -1.5;  // x1
-	ctrlp[3]  = -0.5;  // y1
-	ctrlp[4]  = -1.5;  // x2
-	ctrlp[5]  =  0.0;  // y2
-	ctrlp[6]  = -1.25; // x3
-	ctrlp[7]  =  0.5;  // y3
-	ctrlp[8]  = -0.75; // x4
-	ctrlp[9]  =  0.75; // y4
-	ctrlp[10] =  0.0;  // x5
-	ctrlp[11] =  0.5;  // y5
-	ctrlp[12] =  0.5;  // x6
-	ctrlp[13] =  0.0;  // y6
+	ctrlp[0]  = (tsReal) -1.75; // x0
+	ctrlp[1]  = (tsReal) -1.0;  // y0
+	ctrlp[2]  = (tsReal) -1.5;  // x1
+	ctrlp[3]  = (tsReal) -0.5;  // y1
+	ctrlp[4]  = (tsReal) -1.5;  // x2
+	ctrlp[5]  = (tsReal)  0.0;  // y2
+	ctrlp[6]  = (tsReal) -1.25; // x3
+	ctrlp[7]  = (tsReal)  0.5;  // y3
+	ctrlp[8]  = (tsReal) -0.75; // x4
+	ctrlp[9]  = (tsReal)  0.75; // y4
+	ctrlp[10] = (tsReal)  0.0;  // x5
+	ctrlp[11] = (tsReal)  0.5;  // y5
+	ctrlp[12] = (tsReal)  0.5;  // x6
+	ctrlp[13] = (tsReal)  0.0;  // y6
 	spline.setControlPoints(ctrlp);
 
 	// Evaluate `spline` at u = 0.4 using 'eval'.
-	std::vector<tinyspline::real> result = spline.eval(0.4).result();
+	std::vector<tinyspline::real> result = spline.eval(0.4f).result();
 	std::cout << "x = " << result[0] << ", y = " << result[1] << std::endl;
 
 	// Derive `spline` and subdivide it into a sequence of Bezier curves.
 	tinyspline::BSpline beziers = spline.derive().toBeziers();
 
 	// Evaluate `beziers` at u = 0.3 using '()' instead of 'eval'.
-	result = beziers(0.3).result();
+	result = beziers((tsReal) 0.3).result();
 	std::cout << "x = " << result[0] << ", y = " << result[1] << std::endl;
 
 	return 0;

src/tinyspline.c

@@ -155,54 +155,16 @@ size_t ts_bspline_degree(const tsBSpline *spline)
 	return spline->pImpl->deg;
 }
 
-tsError ts_bspline_set_degree(tsBSpline *spline, size_t deg, tsStatus *status)
-{
-	if (deg >= ts_bspline_num_control_points(spline)) {
-		TS_RETURN_2(status, TS_DEG_GE_NCTRLP,
-			"degree (%lu) >= num(control_points) (%lu)",
-			(unsigned long) deg,
-			(unsigned long) ts_bspline_num_control_points(spline))
-	}
-	spline->pImpl->deg = deg;
-	TS_RETURN_SUCCESS(status)
-}
-
 size_t ts_bspline_order(const tsBSpline *spline)
 {
 	return ts_bspline_degree(spline) + 1;
 }
 
-tsError ts_bspline_set_order(tsBSpline *spline, size_t order, tsStatus *status)
-{
-	if (order == 0 || order > ts_bspline_num_control_points(spline)) {
-		TS_RETURN_2(status, TS_DEG_GE_NCTRLP,
-			"order (%lu) > num(control_points) (%lu)",
-			(unsigned long) order,
-			(unsigned long) ts_bspline_num_control_points(spline))
-	}
-	return ts_bspline_set_degree(spline, order - 1, status);
-}
-
 size_t ts_bspline_dimension(const tsBSpline *spline)
 {
 	return spline->pImpl->dim;
 }
 
-tsError ts_bspline_set_dimension(tsBSpline *spline, size_t dim,
-	tsStatus *status)
-{
-	if (dim == 0)
-		TS_RETURN_0(status, TS_DIM_ZERO, "unsupported dimension: 0")
-	if (ts_bspline_len_control_points(spline) % dim != 0) {
-		TS_RETURN_2(status, TS_LCTRLP_DIM_MISMATCH,
-			"len(control_points) (%lu) %% dimension (%lu) != 0",
-			(unsigned long) ts_bspline_len_control_points(spline),
-			(unsigned long) dim)
-	}
-	spline->pImpl->dim = dim;
-	TS_RETURN_SUCCESS(status)
-}
-
 size_t ts_bspline_len_control_points(const tsBSpline *spline)
 {
 	return ts_bspline_num_control_points(spline) *

src/tinyspline.h

@@ -514,23 +514,6 @@ typedef struct
  */
 size_t TINYSPLINE_API ts_bspline_degree(const tsBSpline *spline);
 
-/**
- * Sets the degree of \p spline.
- *
- * @param[out] spline
- * 	The spline whose degree is set.
- * @param[in] deg
- * 	The degree to be set.
- * @param[out] status
- * 	The status of this function. May be NULL.
- * @return TS_SUCCESS
- * 	On success.
- * @return TS_DEG_GE_NCTRLP
- * 	If \p degree >= ts_bspline_get_control_points(spline).
- */
-tsError TINYSPLINE_API ts_bspline_set_degree(tsBSpline *spline, size_t deg,
-	tsStatus *status);
-
 /**
  * Returns the order (degree + 1) of \p spline.
  *
@@ -541,25 +524,6 @@ tsError TINYSPLINE_API ts_bspline_set_degree(tsBSpline *spline, size_t deg,
  */
 size_t TINYSPLINE_API ts_bspline_order(const tsBSpline *spline);
 
-/**
- * Sets the order (degree + 1) of \p spline.
- *
- * @param[out] spline
- * 	The spline whose order is set.
- * @param[in] order
- * 	The order to be set.
- * @param[out] status
- * 	The status of this function. May be NULL.
- * @return TS_SUCCESS
- * 	On success.
- * @return TS_DEG_GE_NCTRLP
- * 	If \p order > ts_bspline_get_control_points(spline) or if \p order == 0
- * 	( due to the underflow resulting from: order - 1 => 0 - 1 => INT_MAX
- * 	which always is >= ts_bspline_get_control_points(spline) ).
- */
-tsError TINYSPLINE_API ts_bspline_set_order(tsBSpline *spline, size_t order,
-	tsStatus *status);
-
 /**
  * Returns the dimension of \p spline. The dimension of a spline describes the
  * number of components for each point in ts_bspline_get_control_points(spline).
@@ -573,33 +537,6 @@ tsError TINYSPLINE_API ts_bspline_set_order(tsBSpline *spline, size_t order,
  */
 size_t TINYSPLINE_API ts_bspline_dimension(const tsBSpline *spline);
 
-/**
- * Sets the dimension of \p spline. The following conditions must be satisfied:
- *
- * 	(1) dim >= 1
- * 	(2) len_control_points(spline) % dim == 0
- *
- * with _len_control_points_ being the length of the control point array of \p
- * spline. The dimension of a spline describes the number of components for
- * each point in ts_bspline_get_control_points(spline). One-dimensional splines
- * are possible, albeit their benefit might be questionable.
- *
- * @param[out] spline
- * 	The spline whose dimension is set.
- * @param[in] dim
- * 	The dimension to be set.
- * @param[out] status
- * 	The status of this function. May be NULL.
- * @return TS_SUCCESS
- * 	On success.
- * @return TS_DIM_ZERO
- * 	If \p dimension == 0.
- * @return TS_LCTRLP_DIM_MISMATCH
- * 	If len_control_points(spline) % \p dim != 0
- */
-tsError TINYSPLINE_API ts_bspline_set_dimension(tsBSpline *spline, size_t dim,
-	tsStatus *status);
-
 /**
  * Returns the length of the control point array of \p spline.
  *

test/CMakeLists.txt

@@ -1,6 +1,28 @@
+###############################################################################
+### Build CuTest.
+###############################################################################
+add_library(cutest STATIC "cutest/CuTest.c")
+target_include_directories(cutest PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/cutest")
+if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+	# Disable the warnings about sprintf.
+	target_compile_definitions(cutest PRIVATE _CRT_SECURE_NO_WARNINGS)
+endif()
+
+
+
+###############################################################################
+### Build testutils.
+###############################################################################
+add_library(testutils STATIC "testutils.c")
+target_include_directories(cutest PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}")
+target_link_libraries(testutils PUBLIC cutest tinyspline)
+
+
+
 ###############################################################################
 ### Check if code coverage is available. Coverage is measured and visualized
-### with gcov, lcov, and genthml.
+### using gcov, lcov, and genthml. If one of these tools is missing, code
+### coverage cannot be generated.
 #
 # TINYSPLINE_COVERAGE_AVAILABLE
 #   TRUE if the tools that are required to generate code coverage are
@@ -61,19 +83,38 @@ set(TINYSPLINE_COVERAGE_C_LIBRARIES
 
 
 ###############################################################################
-### Add subdirectories containing the actual unit tests.
+### Add subdirectories containing the unit tests.
 ###############################################################################
 add_subdirectory(c)
+add_subdirectory(cxx)
 
 
 
 ###############################################################################
 ### Subsume unit tests and code coverage with custom targets.
 ###############################################################################
 add_custom_target(tests
-	COMMAND tinyspline_tests
-	DEPENDS tinyspline_tests
+	DEPENDS tinyspline_tests tinysplinecxx_tests
+	COMMAND tinyspline_tests tinysplinecxx_tests
 )
 add_custom_target(coverage
 	DEPENDS tinyspline_coverage
 )
+
+
+
+###############################################################################
+### Add a custom target for checking memory issues with CTest.
+###############################################################################
+add_custom_target(memcheck
+	DEPENDS tests
+	COMMAND
+		${CMAKE_CTEST_COMMAND} -T memcheck
+	COMMAND
+		${CMAKE_COMMAND} -E cat
+		"${CMAKE_BINARY_DIR}/Testing/Temporary/MemoryChecker.1.log"
+	COMMAND
+		${CMAKE_COMMAND} -E cat
+		"${CMAKE_BINARY_DIR}/Testing/Temporary/MemoryChecker.2.log"
+	WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
+)

test/c/CMakeLists.txt

@@ -1,21 +1,9 @@
-###############################################################################
-### Setup compiler suite.
-###############################################################################
-if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
-	# Disable the warnings about sprintf in CuTest.
-	add_definitions("/D_CRT_SECURE_NO_WARNINGS")
-endif()
-
-
-
 ###############################################################################
 ### Create unit tests.
 ###############################################################################
 file(GLOB_RECURSE TINYSPLINE_TESTS_SOURCE_FILES "*.c")
-include_directories(cutest)
-add_executable(tinyspline_tests "utils.h" ${TINYSPLINE_TESTS_SOURCE_FILES})
-target_link_libraries(tinyspline_tests
-	PRIVATE tinyspline)
+add_executable(tinyspline_tests ${TINYSPLINE_TESTS_SOURCE_FILES})
+target_link_libraries(tinyspline_tests PRIVATE testutils)
 
 if(EMSCRIPTEN)
 	add_test(NAME tinyspline_tests
@@ -34,15 +22,17 @@ endif()
 ### Create code coverage.
 ###############################################################################
 if(TINYSPLINE_COVERAGE_AVAILABLE)
-	include_directories(${TINYSPLINE_C_INCLUDE_DIR})
 	add_executable(tinyspline_tests_coverage
 		EXCLUDE_FROM_ALL
 		${TINYSPLINE_TESTS_SOURCE_FILES}
 		${TINYSPLINE_C_SOURCE_FILES})
+	target_include_directories(tinyspline_tests_coverage
+		PRIVATE ${TINYSPLINE_C_INCLUDE_DIR})
 	set_target_properties(tinyspline_tests_coverage PROPERTIES
 		COMPILE_FLAGS ${TINYSPLINE_COVERAGE_C_FLAGS})
-	target_link_libraries(tinyspline_tests_coverage
-		PRIVATE ${TINYSPLINE_COVERAGE_C_LIBRARIES}
+	target_link_libraries(tinyspline_tests_coverage PRIVATE
+		testutils
+		${TINYSPLINE_COVERAGE_C_LIBRARIES}
 		${TINYSPLINE_C_LINK_LIBRARIES})
 	set(TINYSPLINE_COVERAGE_INFO_FILE coverage.info)
 	add_custom_target(tinyspline_coverage