Merge pull request #9 from NikolasK-source/main

Release 1.0.5

Author: NikolasK-source

.github/workflows/cmake.yml

@@ -1,10 +1,7 @@
 name: CMake
 
 on:
-  push:
-    branches: [ "main", "development" ]
-  pull_request:
-    branches: [ "main" ]
+  [push,  pull_request ]
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "libs/cxxopts"]
     path = libs/cxxopts
     url = https://github.com/NikolasK-source/cxxopts.git
+[submodule "libs/cxxshm"]
+	path = libs/cxxshm
+	url = https://github.com/NikolasK-source/cxxshm.git

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(stdin-to-modbus-shm LANGUAGES CXX VERSION 1.0.4)
+project(stdin-to-modbus-shm LANGUAGES CXX VERSION 1.0.5)
 
 # settings
 set(Target "stdin-to-modbus-shm")    # Executable name (without file extension!)

libs/CMakeLists.txt

@@ -6,7 +6,10 @@
 
 # ---------------------------------------- link libraries --------------------------------------------------------------
 # ======================================================================================================================
-target_link_libraries(${Target} PRIVATE rt)
-
 add_subdirectory(cxxopts EXCLUDE_FROM_ALL)
 target_link_libraries(${Target} PRIVATE cxxopts)
+
+add_subdirectory(cxxshm EXCLUDE_FROM_ALL)
+target_link_libraries(${Target} PRIVATE cxxshm)
+
+target_link_libraries(${Target} PRIVATE rt)

libs/cxxshm

@@ -2,14 +2,12 @@
 # ======================================================================================================================
 
 target_sources(${Target} PRIVATE main.cpp)
-target_sources(${Target} PRIVATE SHM.cpp)
 target_sources(${Target} PRIVATE license.cpp)
 
 
 # ---------------------------------------- header files (*.jpp, *.h, ...) ----------------------------------------------
 # ======================================================================================================================
 
-target_sources(${Target} PRIVATE SHM.hpp)
 target_sources(${Target} PRIVATE input_parse.hpp)
 target_sources(${Target} PRIVATE split_string.hpp)
 target_sources(${Target} PRIVATE license.hpp)

src/CMakeLists.txt

@@ -54,4 +54,29 @@ void print_licenses(std::ostream &o) {
     o << "    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM," << std::endl;
     o << "    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN" << std::endl;
     o << "    THE SOFTWARE." << std::endl;
+    o << std::endl;
+    o << std::endl;
+    o << "cxxshm Library (https://github.com/NikolasK-source/cxxshm)" << std::endl;
+    o << std::endl;
+    o << "    MIT License" << std::endl;
+    o << std::endl;
+    o << "    Copyright (c) 2022 Nikolas Koesling" << std::endl;
+    o << std::endl;
+    o << "    Permission is hereby granted, free of charge, to any person obtaining a copy" << std::endl;
+    o << "    of this software and associated documentation files (the \"Software\"), to deal" << std::endl;
+    o << "    in the Software without restriction, including without limitation the rights" << std::endl;
+    o << "    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell" << std::endl;
+    o << "    copies of the Software, and to permit persons to whom the Software is" << std::endl;
+    o << "    furnished to do so, subject to the following conditions:" << std::endl;
+    o << std::endl;
+    o << "    The above copyright notice and this permission notice shall be included in all" << std::endl;
+    o << "    copies or substantial portions of the Software." << std::endl;
+    o << std::endl;
+    o << "    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR" << std::endl;
+    o << "    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY," << std::endl;
+    o << "    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE" << std::endl;
+    o << "    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER" << std::endl;
+    o << "    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM," << std::endl;
+    o << "    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE" << std::endl;
+    o << "    SOFTWARE." << std::endl;
 }

src/SHM.cpp

@@ -3,10 +3,10 @@
  * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
  */
 
-#include "SHM.hpp"
 #include "input_parse.hpp"
 #include "license.hpp"
 
+#include "cxxshm.hpp"
 #include <csignal>
 #include <cxxopts.hpp>
 #include <filesystem>
@@ -36,7 +36,7 @@ int main(int argc, char **argv) {
     // establish signal handler
     static volatile bool terminate   = false;
     auto                 sig_handler = [](int) { terminate = true; };
-    if (signal(SIGINT, sig_handler) || signal(SIGTERM, sig_handler)) {
+    if (signal(SIGINT, sig_handler) == SIG_ERR || signal(SIGTERM, sig_handler) == SIG_ERR) {
         perror("Failed to establish signal handler");
         exit(EX_OSERR);
     }
@@ -83,7 +83,8 @@ int main(int argc, char **argv) {
         std::cout << std::endl;
         std::cout << "This application uses the following libraries:" << std::endl;
         std::cout << "  - cxxopts by jarro2783 (https://github.com/jarro2783/cxxopts)" << std::endl;
-        exit(EX_OK);
+        std::cout << "  - cxxshm (https://github.com/NikolasK-source/cxxshm)" << std::endl;
+        return EX_OK;
     }
 
     // print version
@@ -96,62 +97,62 @@ int main(int argc, char **argv) {
     // print licenses
     if (args.count("license")) {
         print_licenses(std::cout);
-        exit(EX_OK);
+        return EX_OK;
     }
 
     // open shared memory objects
     const auto &name_prefix = args["name-prefix"].as<std::string>();
 
-    std::unique_ptr<SHM> shm_do;
-    std::unique_ptr<SHM> shm_di;
-    std::unique_ptr<SHM> shm_ao;
-    std::unique_ptr<SHM> shm_ai;
+    std::unique_ptr<cxxshm::SharedMemory> shm_do;
+    std::unique_ptr<cxxshm::SharedMemory> shm_di;
+    std::unique_ptr<cxxshm::SharedMemory> shm_ao;
+    std::unique_ptr<cxxshm::SharedMemory> shm_ai;
 
     try {
-        shm_do = std::make_unique<SHM>(name_prefix + "DO");
-        shm_di = std::make_unique<SHM>(name_prefix + "DI");
-        shm_ao = std::make_unique<SHM>(name_prefix + "AO");
-        shm_ai = std::make_unique<SHM>(name_prefix + "AI");
+        shm_do = std::make_unique<cxxshm::SharedMemory>(name_prefix + "DO");
+        shm_di = std::make_unique<cxxshm::SharedMemory>(name_prefix + "DI");
+        shm_ao = std::make_unique<cxxshm::SharedMemory>(name_prefix + "AO");
+        shm_ai = std::make_unique<cxxshm::SharedMemory>(name_prefix + "AI");
     } catch (const std::system_error &e) {
         std::cerr << e.what() << std::endl;
-        exit(EX_OSERR);
+        return EX_OSERR;
     }
 
     // check shared mem
     if (shm_do->get_size() > MAX_MODBUS_REGS) {
         std::cerr << "shared memory '" << shm_do->get_name() << "is to large to be a valid modbus shared memory."
                   << std::endl;
-        exit(EX_SOFTWARE);
+        return EX_SOFTWARE;
     }
 
     if (shm_di->get_size() > MAX_MODBUS_REGS) {
         std::cerr << "shared memory '" << shm_di->get_name() << "' is to large to be a valid modbus shared memory."
                   << std::endl;
-        exit(EX_SOFTWARE);
+        return EX_SOFTWARE;
     }
 
     if (shm_ao->get_size() / 2 > MAX_MODBUS_REGS) {
         std::cerr << "shared memory '" << shm_ao->get_name() << "' is to large to be a valid modbus shared memory."
                   << std::endl;
-        exit(EX_SOFTWARE);
+        return EX_SOFTWARE;
     }
 
     if (shm_ai->get_size() / 2 > MAX_MODBUS_REGS) {
         std::cerr << "shared memory '" << shm_ai->get_name() << "' is to large to be a valid modbus shared memory."
                   << std::endl;
-        exit(EX_SOFTWARE);
+        return EX_SOFTWARE;
     }
 
     if (shm_ao->get_size() % 2) {
         std::cerr << "the size of shared memory '" << shm_ao->get_name() << "' is odd. It is not a valid modbus shm."
                   << std::endl;
-        exit(EX_SOFTWARE);
+        return EX_SOFTWARE;
     }
 
     if (shm_ai->get_size() % 2) {
         std::cerr << "the size of shared memory '" << shm_ai->get_name() << "' is odd. It is not a valid modbus shm."
                   << std::endl;
-        exit(EX_SOFTWARE);
+        return EX_SOFTWARE;
     }
 
     const std::size_t do_elements = shm_do->get_size();