Removing the custom debug option for in favor of CMAKE_BUILD_TYPE arg. Added an option to enable the locale testing since it is platform specific and dependent

Author: LinuxDevon

CMakeLists.txt

@@ -3,8 +3,8 @@ cmake_minimum_required(VERSION 3.16)
 project(dbc VERSION 0.2.0 DESCRIPTION "C++ DBC Parser")
 
 # -- PROJECT OPTIONS  -- #
-option(DEBUG "use debug flag" NO)
 option(DBC_ENABLE_TESTS "Enable Unittests" ON)
+option(DBC_TEST_LOCALE_INDEPENDENCE "Used to deterime if the libary is locale agnostic when it comes to converting floats. You need `de_DE.UTF-8` locale installed for this testing." OFF)
 # Turn OFF, if you are using FetchContent to include it to your project
 option(DBC_FETCH_CONTENT_INCLUSION "Include project with FetchContent_Declare in another project. In this case the headers and the cmake files are not needed, only the library" OFF)
 option(DBC_GENERATE_DOCS "Use doxygen if installed to generated documentation files" OFF)
@@ -45,22 +45,17 @@ set(GCC_COMPILE_FLAGS "-Wextra -Wall -Wfloat-equal -Wundef -Wshadow \
 -Waggregate-return -Wcast-qual -Wswitch-default -Wswitch-enum -Wconversion \
 -Wunreachable-code -Wformat=2 -Werror -Wuninitialized -Winit-self")
 
-if(DEBUG)
-	set(GCC_COMPILE_FLAGS ${GCC_COMPILE_FLAGS}" -g")
-else()
-	set(GCC_COMPILE_FLAGS ${GCC_COMPILE_FLAGS}" -O2")
-endif()
-
 set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
 
 # add where to find the source files
-# file(GLOB_RECURSE SOURCE ${PROJECT_SOURCE_DIR}/src/ *.cpp)
-list(APPEND SOURCE ${PROJECT_SOURCE_DIR}/src/utils.cpp
-				   ${PROJECT_SOURCE_DIR}/src/message.cpp
-				   ${PROJECT_SOURCE_DIR}/src/signal.cpp
-				   ${PROJECT_SOURCE_DIR}/src/dbc.cpp)
+list(APPEND SOURCE_FILES
+    ${PROJECT_SOURCE_DIR}/src/utils.cpp
+	${PROJECT_SOURCE_DIR}/src/message.cpp
+	${PROJECT_SOURCE_DIR}/src/signal.cpp
+	${PROJECT_SOURCE_DIR}/src/dbc.cpp
+)
 
-set(HEADER_FILES
+list(APPEND HEADER_FILES
   ${PROJECT_SOURCE_DIR}/include/libdbc/dbc.hpp
   ${PROJECT_SOURCE_DIR}/include/libdbc/message.hpp
   ${PROJECT_SOURCE_DIR}/include/libdbc/signal.hpp
@@ -77,7 +72,7 @@ if(DBC_GENERATE_DOCS)
     add_subdirectory(doc)
 endif()
 
-add_library(${PROJECT_NAME} STATIC ${SOURCE})
+add_library(${PROJECT_NAME} STATIC ${SOURCE_FILES})
 target_link_libraries(${PROJECT_NAME} FastFloat::fast_float)
 target_include_directories(${PROJECT_NAME} PUBLIC
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>

README.md

@@ -7,13 +7,19 @@ from the python dbc library here: https://pypi.org/project/cantools/
 ## Building
 
 I am using Cmake to be able to build the tests and the lib. I plan on doing more with it but this is what it
-is for now. I am doing developement on the WSL Ubuntu 18.04 kernel. This doesn't mean that IDEs aren't
+is for now. This doesn't mean that IDEs aren't
 welcome but the build process might not be suited for this. You will need to modify it for your
 needs. Feel free to submit changes so the building process will be more robust.
 
 Here are the steps to get started:
 ```bash
+# Release Build
 cmake -DCMAKE_BUILD_TYPE=Release -Bbuild -H.
+
+# Debug Build
+cmake -DCMAKE_BUILD_TYPE=Debug -Bbuild -H.
+
+# Run the build
 cmake --build build
 ```
 
@@ -35,6 +41,10 @@ cmake -LAH ..
 I am trying to always make sure that this is very well tested code. I am using Catch2 to do this
 testing and if you aren't familiar here is the documentation: https://github.com/catchorg/Catch2/blob/master/docs/Readme.md#top
 
+There is one option you will want for testing: `DBC_TEST_LOCALE_INDEPENDENCE`. This requires the `de_DE.UTF-8` locale installed to test. It is for checking we don't rely on locale to convert floats. i.e. 1.23 vs 1,23
+
+You will need to configure the project to enable this: `cmake -DCMAKE_BUILD_TYPE=Release -DDBC_TEST_LOCALE_INDEPENDENCE=ON -Bbuild -H.`. You will get a warning if it isn't enabled because it isn't enabled by default.
+
 To run the tests locally you can use the following. Assuming you have built the project you should get a test executable.
 ```bash
 ctest --output-on-failure --test-dir build

test/CMakeLists.txt

@@ -25,13 +25,17 @@ catch_discover_tests(dbcParserTests)
 
 # We want a seperate binary for this test. We setup global locals which mess with all of the testing.
 # Opting for a sperate test running so we don't conflict
-add_executable(dbcLocaleTests
-    locale_testing/test_locale_main.cpp
-    common.cpp
-)
+if(DBC_TEST_LOCALE_INDEPENDENCE)
+  add_executable(dbcLocaleTests
+      locale_testing/test_locale_main.cpp
+      common.cpp
+  )
 
-target_compile_definitions(dbcLocaleTests PRIVATE TESTDBCFILES_PATH="${CMAKE_CURRENT_SOURCE_DIR}/dbcs")
-target_link_libraries(dbcLocaleTests PRIVATE dbc Catch2::Catch2WithMain)
-target_include_directories(dbcLocaleTests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+  target_compile_definitions(dbcLocaleTests PRIVATE TESTDBCFILES_PATH="${CMAKE_CURRENT_SOURCE_DIR}/dbcs")
+  target_link_libraries(dbcLocaleTests PRIVATE dbc Catch2::Catch2WithMain)
+  target_include_directories(dbcLocaleTests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
 
-catch_discover_tests(dbcLocaleTests)
+  catch_discover_tests(dbcLocaleTests)
+else()
+  message(WARNING "Locale independent testing is turned off!")
+endif()