Merge branch 'main' into release

Release 0.1.3

Author: NikolasK-source

.gitignore

@@ -1,6 +1,9 @@
 # general
 build*
-docs/
+docs/*
+
+!docs/index.md
+!docs/_config.yml
 
 # editor files
 

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.1.2)
+project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.1.3)
 
 # settings
 set(Target "Modbus_RTU_client_shm")    # Executable name (without file extension!)

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

docs/index.md

@@ -0,0 +1,4 @@
+# Shared Memory Modbus RTU Client
+
+This project is a simple command line based Modbus TCP client for POSIX compatible operating systems that stores the 
+content of its registers in shared memory.

src/CMakeLists.txt

@@ -4,13 +4,14 @@
 target_sources(${Target} PRIVATE main.cpp)
 target_sources(${Target} PRIVATE modbus_shm.cpp)
 target_sources(${Target} PRIVATE Modbus_RTU_Slave.cpp)
+target_sources(${Target} PRIVATE license.cpp)
 
 
 # ---------------------------------------- header files (*.jpp, *.h, ...) ----------------------------------------------
 # ======================================================================================================================
 target_sources(${Target} PRIVATE modbus_shm.hpp)
 target_sources(${Target} PRIVATE Modbus_RTU_Slave.hpp)
-
+target_sources(${Target} PRIVATE license.hpp)
 
 
 # ---------------------------------------- subdirectories --------------------------------------------------------------

src/Modbus_RTU_Slave.cpp

@@ -1,7 +1,11 @@
+/*
+ * Copyright (C) 2021-2022 Nikolas Koesling <nikolas@koesling.info>.
+ * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
+ */
+
 #include "Modbus_RTU_Slave.hpp"
 
 #include <stdexcept>
-#include <unistd.h>
 
 namespace Modbus {
 namespace RTU {

src/Modbus_RTU_Slave.hpp

@@ -1,3 +1,8 @@
+/*
+ * Copyright (C) 2021-2022 Nikolas Koesling <nikolas@koesling.info>.
+ * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
+ */
+
 #pragma once
 
 #include <modbus/modbus.h>

src/license.cpp

@@ -0,0 +1,14 @@
+/*
+ * Copyright (C) 2022 Nikolas Koesling <nikolas@koesling.info>.
+ * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
+ */
+
+#pragma once
+
+#include <ostream>
+
+/**
+ * \brief print licences
+ * @param o output stream used to print licenses
+ */
+void print_licenses(std::ostream &o);

src/license.hpp

@@ -1,3 +1,8 @@
+/*
+ * Copyright (C) 2021-2022 Nikolas Koesling <nikolas@koesling.info>.
+ * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
+ */
+
 #include <csignal>
 #include <cxxopts.hpp>
 #include <filesystem>
@@ -7,6 +12,7 @@
 #include <unistd.h>
 
 #include "Modbus_RTU_Slave.hpp"
+#include "license.hpp"
 #include "modbus_shm.hpp"
 
 //! terminate flag
@@ -73,6 +79,7 @@ int main(int argc, char **argv) {
     options.add_options()("m,monitor", "output all incoming and outgoing packets to stdout");
     options.add_options()("h,help", "print usage");
     options.add_options()("version", "print version information");
+    options.add_options()("license", "show licences");
     // clang-format on
 
     // parse arguments
@@ -100,29 +107,6 @@ int main(int argc, char **argv) {
         std::cout << "This application uses the following libraries:" << std::endl;
         std::cout << "  - cxxopts by jarro2783 (https://github.com/jarro2783/cxxopts)" << std::endl;
         std::cout << "  - libmodbus by Stéphane Raimbault (https://github.com/stephane/libmodbus)" << std::endl;
-        std::cout << std::endl;
-        std::cout << std::endl;
-        std::cout << "MIT License:" << std::endl;
-        std::cout << std::endl;
-        std::cout << "Copyright (c) 2021 Nikolas Koesling" << std::endl;
-        std::cout << std::endl;
-        std::cout << "Permission is hereby granted, free of charge, to any person obtaining a copy" << std::endl;
-        std::cout << "of this software and associated documentation files (the \"Software\"), to deal" << std::endl;
-        std::cout << "in the Software without restriction, including without limitation the rights" << std::endl;
-        std::cout << "to use, copy, modify, merge, publish, distribute, sublicense, and/or sell" << std::endl;
-        std::cout << "copies of the Software, and to permit persons to whom the Software is" << std::endl;
-        std::cout << "furnished to do so, subject to the following conditions:" << std::endl;
-        std::cout << std::endl;
-        std::cout << "The above copyright notice and this permission notice shall be included in all" << std::endl;
-        std::cout << "copies or substantial portions of the Software." << std::endl;
-        std::cout << std::endl;
-        std::cout << "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR" << std::endl;
-        std::cout << "IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY," << std::endl;
-        std::cout << "FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE" << std::endl;
-        std::cout << "AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER" << std::endl;
-        std::cout << "LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM," << std::endl;
-        std::cout << "OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE" << std::endl;
-        std::cout << "SOFTWARE." << std::endl;
         exit(EX_OK);
     }
 
@@ -132,6 +116,12 @@ int main(int argc, char **argv) {
         exit(EX_OK);
     }
 
+    // print licenses
+    if (args.count("license")) {
+        print_licenses(std::cout);
+        exit(EX_OK);
+    }
+
     // check arguments
     if (args["do-registers"].as<std::size_t>() > 0x10000) {
         std::cerr << "to many do_registers (maximum: 65536)." << std::endl;

src/main.cpp

@@ -1,7 +1,11 @@
+/*
+ * Copyright (C) 2021-2022 Nikolas Koesling <nikolas@koesling.info>.
+ * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
+ */
+
 #include "modbus_shm.hpp"
 
 #include <fcntl.h>
-#include <iostream>
 #include <stdexcept>
 #include <sys/mman.h>
 #include <system_error>

src/modbus_shm.cpp

@@ -1,3 +1,8 @@
+/*
+ * Copyright (C) 2021-2022 Nikolas Koesling <nikolas@koesling.info>.
+ * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
+ */
+
 #pragma once
 
 #include "modbus/modbus.h"