Merge branch 'main' into release

Author: NikolasK-source

.github/workflows/cmake.yml

@@ -18,25 +18,68 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    
-    - name: Init submodules
-      run: git submodule init
-      
-    - name: Update submodules
-      run: git submodule update
+
+    - name: create tmp dir
+      run: mkdir tmp
+
+    - name: update
+      run: |
+        sudo apt update
+        sudo apt upgrade -y
+
+    - name: install cxxopts
+      run: |
+        git clone https://github.com/jarro2783/cxxopts.git tmp/cxxopts
+        cd tmp/cxxopts
+        git checkout $(git tag | grep -P '^v\d+\.\d+\.\d+$' | sort | tail -1)
+        cmake -B build . -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF -DCLANG_TIDY=OFF
+        cmake --build build
+        sudo cmake --install build
+        cd -
+
+    - name: install cxxshm
+      run: |
+        git clone https://github.com/NikolasK-source/cxxshm.git tmp/cxxshm
+        cd tmp/cxxshm
+        git checkout $(git tag | grep -P '^v\d+\.\d+\.\d+$' | sort | tail -1)
+        cmake -B build . -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF -DCLANG_TIDY=OFF
+        cmake --build build
+        sudo cmake --install build
+        cd -
+
+    - name: install cxxsemaphore
+      run: |
+        git clone https://github.com/NikolasK-source/cxxsemaphore.git tmp/cxxsemaphore
+        cd tmp/cxxsemaphore
+        git checkout $(git tag | grep -P '^v\d+\.\d+\.\d+$' | sort | tail -1)
+        cmake -B build . -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF -DCLANG_TIDY=OFF
+        cmake --build build
+        sudo cmake --install build
+        cd -
+
+    - name: install libmodbus
+      run: |
+        git clone https://github.com/stephane/libmodbus.git tmp/libmodbus
+        cd tmp/libmodbus
+        git checkout $(git tag | grep -P '^v\d+\.\d+\.\d+$' | sort | tail -1)
+        autoreconf --install --symlink --force
+        ./configure
+        make
+        sudo make install
+        cd -
 
     - name: Configure CMake
       # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
       # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
-      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF -DCLANG_TIDY=OFF -DBUILD_DOC=OFF
 
     - name: Build
       # Build your program with the given configuration
       run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
 
-    - name: Test
-      working-directory: ${{github.workspace}}/build
+#    - name: Test
+#      working-directory: ${{github.workspace}}/build
       # Execute tests defined by the CMake configuration.  
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
-      run: ctest -C ${{env.BUILD_TYPE}}
+#      run: ctest -C ${{env.BUILD_TYPE}}
 

.github/workflows/flatpak_test.yml renamed to .github/workflows/flatpak.yml

@@ -1,7 +1,5 @@
 on:
-  push:
-    branches: [ "main", "development" ]
-  pull_request:
+  [ push, pull_request ]
 name: Flatpak_test
 jobs:
   flatpak:
@@ -27,4 +25,4 @@ jobs:
       with:
         bundle: test_modbus-tcp-client-shm.flatpak
         manifest-path: network.koesling.test-modbus-rtu-client-shm.yml
-        cache-key: flatpak-builder-${{ github.sha }}
+        cache-key: flatpak-builder-${{ github.sha }}

.github/workflows/flatpak_release.yml

@@ -1,6 +1,7 @@
 # general
 build*
 docs/*
+docs_doxy
 
 !docs/index.md
 !docs/_config.yml

.gitignore

@@ -1,12 +0,0 @@
-[submodule "libs/cxxopts"]
-	path = libs/cxxopts
-    url = https://github.com/NikolasK-source/cxxopts.git
-[submodule "libs/libmodbus"]
-	path = libs/libmodbus
-	url = https://github.com/stephane/libmodbus
-[submodule "libs/cxxshm"]
-	path = libs/cxxshm
-	url = https://github.com/NikolasK-source/cxxshm.git
-[submodule "libs/cxxsemaphore"]
-	path = libs/cxxsemaphore
-	url = https://github.com/NikolasK-source/cxxsemaphore.git

.gitmodules

@@ -9,7 +9,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.3.0)
+project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.4.0)
 
 # settings
 set(Target "modbus-rtu-client-shm")    # Executable name (without file extension!)
@@ -37,154 +37,4 @@ option(ENABLE_TEST "enable test builds" OFF)
 
 # ----------------------------------------------- Do not change --------------------------------------------------------
 # ======================================================================================================================
-
-set(CMAKE_COMPILE_WARNING_AS_ERROR ON)
-
-if (CLANG_TIDY)
-    if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-        if (${CLANG_TIDY_NO_ERRORS})
-            set(CLANG_TIDY_CONFIG_FILE ${CMAKE_SOURCE_DIR}/.clang-tidy-noerrors)
-        else ()
-            set(CLANG_TIDY_CONFIG_FILE ${CMAKE_SOURCE_DIR}/.clang-tidy)
-        endif ()
-
-        set(CMAKE_CXX_CLANG_TIDY
-                clang-tidy
-                -config-file=${CLANG_TIDY_CONFIG_FILE})
-        message(STATUS "clang-tidy enabled: ${CLANG_TIDY_CONFIG_FILE}")
-    else ()
-        message(WARNING "clang-tidy requested, but only available if clang is selected as compiler")
-    endif ()
-endif ()
-
-# add executable
-add_executable(${Target})
-install(TARGETS ${Target})
-
-# set source and libraries directory
-add_subdirectory("src")
-add_subdirectory("libs")
-
-include(warnings.cmake)
-include(define.cmake)
-include(compileropts.cmake)
-
-# force C++ Standard and disable/enable compiler specific extensions
-set_target_properties(${Target} PROPERTIES
-        CXX_STANDARD ${STANDARD}
-        CXX_STANDARD_REQUIRED ON
-        CXX_EXTENSIONS ${COMPILER_EXTENSIONS}
-)
-
-# compiler definitions and options
-set_definitions(${Target})
-if (ENABLE_MULTITHREADING AND OPENMP)
-    set_options(${Target} ON)
-else ()
-    set_options(${Target} OFF)
-endif ()
-
-if (COMPILER_WARNINGS)
-    enable_warnings(${Target})
-    message(STATUS "Compiler warnings enabled.")
-else ()
-    disable_warnings(${Target})
-    message(STATUS "Compiler warnings disabled.")
-endif ()
-
-if (ENABLE_MULTITHREADING)
-    # required by threading lib (std::thread)
-    set(THREADS_PREFER_PTHREAD_FLAG ON)
-    find_package(Threads REQUIRED)
-    target_link_libraries(${Target} PRIVATE Threads::Threads)
-endif ()
-
-# lto
-if (LTO_ENABLED)
-    include(CheckIPOSupported)
-    check_ipo_supported(RESULT ipo_supported OUTPUT error)
-    if (ipo_supported)
-        message(STATUS "IPO / LTO enabled")
-        set_property(TARGET ${Target} PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
-    else ()
-        message(STATUS "IPO / LTO not supported: <${error}>")
-    endif ()
-endif ()
-
-if (BUILD_DOC)
-    # doxygen documentation (https://vicrucann.github.io/tutorials/quick-cmake-doxygen/)
-    # check if Doxygen is installed
-    find_package(Doxygen)
-    if (DOXYGEN_FOUND)
-        # set input and output files
-        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
-        set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
-
-        if (EXISTS ${DOXYGEN_IN})
-            # request to configure the file
-            configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
-            message(STATUS "Doxygen configured")
-
-            # note the option ALL which allows to build the docs together with the application
-            add_custom_target(doc_doxygen_${Target} ALL
-                    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
-                    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-                    COMMENT "Generating API documentation with Doxygen"
-                    VERBATIM)
-            message(STATUS "Added target doc_doxygen_${Target}")
-
-            if (TARGET doc_doxygen)
-                add_dependencies(doc_doxygen doc_doxygen_${Target})
-            else ()
-                add_custom_target(doc_doxygen DEPENDS doc_doxygen_${Target})
-            endif ()
-        else ()
-            message(WARNING "doxygen documentation requested, but file ${DOXYGEN_IN} does not exist.")
-        endif ()
-    else (DOXYGEN_FOUND)
-        message(WARNING "Doxygen must be installed and accessible to generate the doxygen documentation.")
-    endif (DOXYGEN_FOUND)
-endif ()
-
-# add clang format target
-if (CLANG_FORMAT)
-    set(CLANG_FORMAT_FILE ${CMAKE_CURRENT_SOURCE_DIR}/.clang-format)
-
-    if (EXISTS ${CLANG_FORMAT_FILE})
-        include(ClangFormat.cmake)
-        target_clangformat_setup(${Target})
-        message(STATUS "Added clang format target(s)")
-    else ()
-        message(WARNING "Clang format enabled, but file ${CLANG_FORMAT_FILE}  does not exist")
-    endif ()
-endif ()
-
-# add test targets
-if (ENABLE_TEST)
-    enable_testing()
-    add_subdirectory("test")
-endif ()
-
-# generate version_info.cpp
-# output is not the acutal generated file --> command is always executed
-add_custom_command(
-        OUTPUT
-        ${CMAKE_SOURCE_DIR}/src/generated/version_info_cpp
-
-        COMMAND
-        bash ${CMAKE_SOURCE_DIR}/scripts/gen_version_info_cpp.sh ${PROJECT_NAME}
-
-        WORKING_DIRECTORY
-        ${CMAKE_SOURCE_DIR}
-)
-
-execute_process(
-        COMMAND bash "${CMAKE_SOURCE_DIR}/scripts/gen_version_info_cpp.sh" ${PROJECT_NAME}
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
-
-add_custom_target(${Target}_generated_version_info
-        DEPENDS ${CMAKE_SOURCE_DIR}/src/generated/version_info_cpp
-)
-
-add_dependencies(${Target} ${Target}_generated_version_info)
+include(cmake_files/setup.cmake)

CMakeLists.txt

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Modbus TCP Client - Shared Memory"
+PROJECT_NAME           = "Modbus RTU Client - Shared Memory"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -44,7 +44,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "A modbus TCP client that stores its values in shared memory objects"
+PROJECT_BRIEF          = "A modbus RTU client that stores its values in shared memory objects"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs
+OUTPUT_DIRECTORY       = docs_doxy
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and

Doxyfile.in

@@ -2,18 +2,24 @@
 
 Modbus RTU client that stores its data (registers) in shared memory objects.
 
+## Dependencies
+- cxxopts by jarro2783 (https://github.com/jarro2783/cxxopts) (only required for building the application)
+- libmodbus by Stéphane Raimbault (https://github.com/stephane/libmodbus)
+- cxxshm (https://github.com/NikolasK-source/cxxshm)
+- cxxsemaphore (https://github.com/NikolasK-source/cxxsemaphore)
+
+On Arch linux they are available via the official repositories and the AUR:
+- https://archlinux.org/packages/extra/any/cxxopts/
+- https://aur.archlinux.org/packages/libmodbus
+- https://aur.archlinux.org/packages/cxxshm
+- https://aur.archlinux.org/packages/cxxsemaphore
+
 ## Build
 ```
-git submodule init
-git submodule update
-mkdir build
-cd build
-cmake .. -DCMAKE_CXX_COMPILER=$(which clang++) -DCMAKE_BUILD_TYPE=Release -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF
-cmake --build . 
+cmake -B build -DCMAKE_CXX_COMPILER=$(which clang++) -DCMAKE_BUILD_TYPE=Release -DCLANG_FORMAT=OFF -DCLANG_TIDY=OFF -DCOMPILER_WARNINGS=OFF -DBUILD_DOC=OFF
+cmake --build .
 ```
 
-As an alternative to the ```git submodule``` commands, the ```--recursive``` option can be used with ```git clone```.
-
 ## Use
 ```
 modbus-rtu-client-shm [OPTION...]
@@ -54,8 +60,3 @@ The modbus registers are mapped to shared memory objects:
     AO   | Discrete Output Registers | read-write       | <name-prefix>AO
     AI   | Discrete Input Registers  | read-only        | <name-prefix>AI
 ```
-
-## Libraries
-This application uses the following libraries:
-- cxxopts by jarro2783 (https://github.com/jarro2783/cxxopts)
-- libmodbus by Stéphane Raimbault (https://github.com/stephane/libmodbus)