[cmake] Use CMake configurations for compiler flags + generate version number from main CMakeLists.txt

Author: c-jimenez

.github/workflows/c-cpp.yml

@@ -13,11 +13,21 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: make gcc
-      run: make gcc-native
-    - name: unit tests gcc
+    - name: make gcc Debug
+      run: make gcc-native BUILD_TYPE=Debug
+    - name: unit tests gcc Debug
       run: make tests-gcc-native
-    - name: make clang
-      run: make clang-native
+    - name: make clang Debug
+      run: make clang-native Debug
     - name: unit tests clang
-      run: make tests-clang-native
+      run: make tests-clang-native BUILD_TYPE=Debug
+    - name: clean
+      run: make clean
+    - name: make gcc Release
+      run: make gcc-native BUILD_TYPE=Release
+    - name: unit tests gcc Release
+      run: make tests-gcc-native
+    - name: make clang Debug
+      run: make clang-native Release
+    - name: unit tests clang
+      run: make tests-clang-native BUILD_TYPE=Release

3rdparty/CMakeLists.txt

@@ -8,7 +8,9 @@ add_library(doctest INTERFACE)
 target_include_directories(doctest INTERFACE doctest/doctest)
 
 # Use default flags for the libwebsockets library
-set(CMAKE_C_FLAGS   "-g -ggdb")
-set(CMAKE_CXX_FLAGS "-g -ggdb")
+set(CMAKE_C_FLAGS_DEBUG     "-O0 -g3 -ggdb3")
+set(CMAKE_CXX_FLAGS_DEBUG   "-O0 -g3 -ggdb3")
+set(CMAKE_C_FLAGS_RELEASE   "-O2 -DNDEBUG")
+set(CMAKE_CXX_FLAGS_RELEASE "-O2 -DNDEBUG")
 
 add_subdirectory(libwebsockets)

CMakeLists.txt

@@ -8,6 +8,11 @@ project(OpenOCPP DESCRIPTION "Open Source C++ implementation of the OCPP 1.6 pro
                  VERSION 0.5.0
 )
 
+# Definitions for Version.h file
+add_definitions(-DLIBOPENOCPP_MAJOR="${PROJECT_VERSION_MAJOR}")
+add_definitions(-DLIBOPENOCPP_MINOR="${PROJECT_VERSION_MINOR}")
+add_definitions(-DLIBOPENOCPP_FIX="${PROJECT_VERSION_PATCH}")
+
 # Build options
 include(CMakeLists_Options.txt)
 
@@ -118,15 +123,15 @@ set(PKG_CONFIG_CFLAGS       "-I\${includedir}")
 
 set(LIB_NAME                "open-ocpp")
 configure_file(
-  "${CMAKE_CURRENT_SOURCE_DIR}/libopen-ocpp.pc.in"
+  "${CMAKE_CURRENT_SOURCE_DIR}/deploy/libopen-ocpp.pc.in"
   "${CMAKE_CURRENT_BINARY_DIR}/libopen-ocpp.pc"
 )
 install(FILES "${CMAKE_BINARY_DIR}/libopen-ocpp.pc" DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
 
 if(${BUILD_STATIC_LIBRARY})
     set(LIB_NAME                "open-ocpp_static")
     configure_file(
-    "${CMAKE_CURRENT_SOURCE_DIR}/libopen-ocpp.pc.in"
+    "${CMAKE_CURRENT_SOURCE_DIR}/deploy/libopen-ocpp.pc.in"
     "${CMAKE_CURRENT_BINARY_DIR}/libopen-ocpp_static.pc"
     )
     install(FILES "${CMAKE_BINARY_DIR}/libopen-ocpp_static.pc" DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)

CMakeLists_Options.txt

@@ -10,7 +10,7 @@ add_compile_definitions(LOG_LEVEL=${LOG_LEVEL})
 
 # Static library
 if(NOT DEFINED BUILD_STATIC_LIBRARY)
-    set(BUILD_STATIC_LIBRARY    OFF)
+    set(BUILD_STATIC_LIBRARY    ON)
 endif()
 
 # Unit tests

CMakeLists_native.txt

@@ -2,13 +2,6 @@
 #        Native target toolchain definition and specific compiler flags         #
 #################################################################################
 
-# Optimization flags
-if (DEBUG)
-    set(OPTIMIZATION_FLAGS "-O0 -g -ggdb")
-else()
-    set(OPTIMIZATION_FLAGS "-O2")
-endif()
-
 # Warnings
 set(WARNING_FLAGS "-Wall -Wextra -Werror")
 
@@ -17,5 +10,7 @@ set(C_FLAGS "-std=c11")
 set(CXX_FLAGS "-std=c++17")
 
 # Set compiler flags
-set(CMAKE_C_FLAGS   "${C_FLAGS} ${WARNING_FLAGS} ${OPTIMIZATION_FLAGS}")
-set(CMAKE_CXX_FLAGS "${CXX_FLAGS} ${WARNING_FLAGS} ${OPTIMIZATION_FLAGS}")
+set(CMAKE_C_FLAGS_DEBUG     "${C_FLAGS} ${WARNING_FLAGS} -O0 -g3 -ggdb3")
+set(CMAKE_CXX_FLAGS_DEBUG   "${CXX_FLAGS} ${WARNING_FLAGS} -O0 -g3 -ggdb3")
+set(CMAKE_C_FLAGS_RELEASE   "${C_FLAGS} ${WARNING_FLAGS} -O2 -DNDEBUG")
+set(CMAKE_CXX_FLAGS_RELEASE "${CXX_FLAGS} ${WARNING_FLAGS} -O2 -DNDEBUG")

README.md

@@ -309,13 +309,13 @@ The build is based on CMake, the following definitions must be passed to the CMa
 
 * **TARGET** : Allow to load the appropriate *CMakeLists_TARGET.txt* file
 * **BIN_DIR** : Output directory for the generated binaries
-* **DEBUG** : If set to ON, use DEBUG compilation flag, otherwise use release compilation flags
+* **CMAKE_BUILD_TYPE** : Can be set to either Debug or Release (Release build produces optimized stripped binaries)
 
 Additionnaly, the **CMakeLists_Options.txt** contains several options that can be switched on/off.
 
 An helper makefile is available at project's level to simplify the use of CMake. Just use the one of the following commands to build using gcc or gcc without cross compilation :
 
-```make gcc-native``` or ```make clang-native```
+```make gcc-native``` or ```make clang-native``` or ```make gcc-native BUILD_TYPE=Debug``` or ```make clang-native BUILD_TYPE=Debug``` 
 
 This makefile also contains the corresponding cleaning targets :
 

libopen-ocpp.pc.in renamed to deploy/libopen-ocpp.pc.in

@@ -175,7 +175,7 @@ int main(int argc, char* argv[])
         while (true)
         {
             // Check connector state
-            unsigned int connector_id;
+            unsigned int connector_id = 0;
             std::string  id_tag;
             bool         restore = false;
             for (unsigned int i = 1; i <= config.ocppConfig().numberOfConnectors(); i++)

examples/remote_chargepoint/main.cpp

@@ -10,14 +10,16 @@ BIN_DIR:=$(ROOT_DIR)/bin
 
 # Make options
 #VERBOSE="VERBOSE=1"
-PARALLEL_BUILD:=-j 4
-DEBUG:=ON
+PARALLEL_BUILD?=-j 4
+
+# Build type can be either Debug or Release
+BUILD_TYPE?=Release
 
 # Default target
 default: gcc-native
 
-# Silent makefile if not verbose mode
-$(VERBOSE).SILENT:
+# Silent makefile
+.SILENT:
 
 # Install prefix
 ifneq ($(strip $(INSTALL_PREFIX)),)
@@ -57,7 +59,7 @@ $(GCC_NATIVE_BUILD_DIR)/Makefile:
 	@echo "Generating gcc-native makefiles..."
 	@mkdir -p $(GCC_NATIVE_BUILD_DIR)
 	@mkdir -p $(GCC_NATIVE_BIN_DIR)
-	@cd $(GCC_NATIVE_BUILD_DIR) && export CC=gcc && export CXX=g++ && cmake -D TARGET=native -D BIN_DIR=$(GCC_NATIVE_BIN_DIR) -D DEBUG=$(DEBUG) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)
+	@cd $(GCC_NATIVE_BUILD_DIR) && export CC=gcc && export CXX=g++ && cmake -D CMAKE_BUILD_TYPE=$(BUILD_TYPE) -D TARGET=native -D BIN_DIR=$(GCC_NATIVE_BIN_DIR) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)
 
 
 # Targets for clang-native build
@@ -87,4 +89,4 @@ $(CLANG_NATIVE_BUILD_DIR)/Makefile:
 	@echo "Generating clang-native makefiles..."
 	@mkdir -p $(CLANG_NATIVE_BUILD_DIR)
 	@mkdir -p $(CLANG_NATIVE_BIN_DIR)
-	@cd $(CLANG_NATIVE_BUILD_DIR) && export CC=clang && export CXX=clang++ && cmake -D TARGET=native -D _CMAKE_TOOLCHAIN_PREFIX=llvm- -D BIN_DIR=$(CLANG_NATIVE_BIN_DIR) -D DEBUG=$(DEBUG) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)
+	@cd $(CLANG_NATIVE_BUILD_DIR) && export CC=clang && export CXX=clang++ && cmake -D CMAKE_BUILD_TYPE=$(BUILD_TYPE) -D TARGET=native -D _CMAKE_TOOLCHAIN_PREFIX=llvm- -D BIN_DIR=$(CLANG_NATIVE_BIN_DIR) $(CMAKE_INSTALL_PREFIX) $(ROOT_DIR)

makefile

@@ -23,8 +23,11 @@ along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
  *          XX = Major version number (increase = API compatibility broken and/or major feature addition)
  *          YY = Minor version number (increase = Minor feature addition)
  *          ZZ = Fix version number (increase = Bug fix(es))
+ *
+ *          Stack version number is defined in the main CMakeLists.txt file of
+ *          the build tree
  */
-#define OPEN_OCPP_VERSION "0.5.0"
+#define OPEN_OCPP_VERSION LIBOPENOCPP_MAJOR "." LIBOPENOCPP_MINOR "." LIBOPENOCPP_FIX
 
 /** @brief Return the version string of the library */
 extern "C" const char* OPEN_OCPP_Version();