Support for Windows compilation

Thanks for contributions from:
- RalfOGit <https://github.com/RalfOGit>
- MightyPiggie <https://github.com/MightyPiggie>

PR: #5

Co-authored-by: RalfOGit
Co-authored-by: MightyPiggie <[email protected]>
Signed-off-by: Mateusz Mazur <[email protected]>

Author: Mazurel

.github/workflows/cmake-multi-platform.yml

@@ -30,9 +30,10 @@ jobs:
           - os: ubuntu-latest
             c_compiler: clang
             cpp_compiler: clang++
-        exclude:
           - os: windows-latest
             c_compiler: cl
+            cpp_compiler: cl
+        exclude:
           - os: windows-latest
             c_compiler: gcc
           - os: windows-latest
@@ -67,11 +68,12 @@ jobs:
           -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
           -DMODBUS_EXAMPLE=ON
           -DMODBUS_TESTS=ON
-          -DMODBUS_COMMUNICATION=${{ matrix.os == 'windows-latest' && 'OFF' || matrix.os == 'ubuntu-latest' && 'ON' }}
+          -DMODBUS_TCP_COMMUNICATION=${{ matrix.os == 'windows-latest' && 'OFF' || matrix.os == 'ubuntu-latest' && 'ON' }}
+          -DMODBUS_SERIAL_COMMUNICATION=${{ matrix.os == 'windows-latest' && 'OFF' || matrix.os == 'ubuntu-latest' && 'ON' }}
           -S ${{ github.workspace }}
 
       - name: Build
         run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
 
       - name: Test
-        run: ${{ steps.strings.outputs.build-output-dir }}/tests/Google_Tests_run
+        run: ${{ steps.strings.outputs.build-output-dir }}/${{ matrix.os == 'windows-latest' && 'tests\Release\Google_Tests_run.exe' || matrix.os == 'ubuntu-latest' && '/tests/Google_Tests_run' }}

.gitignore

@@ -30,9 +30,12 @@
 *.exe
 *.out
 *.app
-
 build
 
+# Windows specific
+out
+.vs
+
 # Gtags
 GTAGS
 GRTAGS

CMakeLists.txt

@@ -1,17 +1,26 @@
 cmake_minimum_required(VERSION 3.13)
-project(protocolConverter)
+project(modbus)
 
 set(CMAKE_CXX_STANDARD 17)
 
 if (MSVC)
     add_compile_options(/W3)
+    # Otherwise, MSVC complains about strncopy
+    add_definitions(-D_CRT_SECURE_NO_WARNINGS)
 else()
     add_compile_options(-Wall -Wextra -Werror -pedantic)
 endif()
 
 option(MODBUS_EXAMPLE "Build example program" OFF)
 option(MODBUS_TESTS "Build tests" OFF)
-option(MODBUS_COMMUNICATION "Use Modbus communication library" ON)
+option(MODBUS_TCP_COMMUNICATION "Use Modbus TCP communication library" ON)
+
+if(NOT win32)
+    # Serial not supported on Windows
+    option(MODBUS_SERIAL_COMMUNICATION "Use Modbus serial communication library" OFF)  # not supported by windows platform
+else()
+    message(STATUS "Modbus Serial not supported on Windows.")
+endif()
 
 add_subdirectory(src)
 
@@ -21,5 +30,5 @@ endif()
 
 if(MODBUS_EXAMPLE)
     add_executable(ex example/main.cpp)
-    target_link_libraries(ex Modbus)
+    target_link_libraries(ex PUBLIC Modbus_Core)
 endif()

include/MB/crc.hpp

@@ -1,13 +1,19 @@
 #include <cstdint>
+#include <optional>
 #include <vector>
 
 //! This namespace contains functions used for CRC calculation
 namespace MB::CRC {
-    //! Calculates CRC based on the input buffer - C style
-    uint16_t calculateCRC(const uint8_t *buff, std::size_t len);
+//! Calculates CRC based on the input buffer - C style
+uint16_t calculateCRC(const uint8_t *buff, std::size_t len);
 
-    //! Calculate CRC based on the input vector of bytes
-    inline uint16_t calculateCRC(const std::vector<uint8_t> &buffer) {
-        return calculateCRC(buffer.begin().base(), buffer.size());
+//! Calculate CRC based on the input vector of bytes
+inline uint16_t calculateCRC(const std::vector<uint8_t> &buffer, std::optional<std::size_t> len = std::nullopt) {
+    std::size_t bufferLength = buffer.size();
+    if (len.has_value() && bufferLength >= *len) {
+        bufferLength = *len;
     }
-};
+
+    return calculateCRC(static_cast<const uint8_t *>(&(*buffer.begin())), bufferLength);
+}
+}; // namespace MB::CRC

include/MB/modbusCell.hpp

@@ -5,7 +5,7 @@
 #pragma once
 
 #include <cstdint>
-#include <stdexcept>
+#include <string>
 #include <variant>
 
 /**

include/MB/modbusException.hpp

@@ -4,9 +4,10 @@
 
 #pragma once
 
+#include <algorithm>
+#include <cstddef>
 #include <cstdint>
 #include <cstring>
-#include <stdexcept>
 #include <vector>
 
 #include "modbusUtils.hpp"
@@ -81,12 +82,14 @@ class ModbusException : public std::exception {
 
     /**
      * This function is less optimal, it is just to be compatible with
-     * std::excepetion You should preferably use toString()
+     * `std::exception`, you should preferably use toString()
      */
     [[nodiscard]] const char *what() const noexcept override {
-        auto og   = toString();
-        char *str = new char[og.size()];
-        stpcpy(str, og.c_str());
+        const std::size_t MAX_STRING_SIZE = 1024;
+        static char str[MAX_STRING_SIZE];
+        auto originalStr = toString();
+        std::strncpy(str, originalStr.c_str(),
+                     std::min(originalStr.size(), MAX_STRING_SIZE));
         return str;
     }
 

include/MB/modbusRequest.hpp

@@ -81,14 +81,14 @@ class ModbusRequest {
         std::vector<ModbusCell> values = {}) noexcept;
 
     /**
-    * Copy constructor for the response.
-    */
-    ModbusRequest(const ModbusRequest&);
+     * Copy constructor for the response.
+     */
+    ModbusRequest(const ModbusRequest &);
 
     /**
-    * Equal operator for the response.
-    */
-    ModbusRequest& operator=(const ModbusRequest &);
+     * Equal operator for the response.
+     */
+    ModbusRequest &operator=(const ModbusRequest &);
 
     //! Returns string representation of object
     [[nodiscard]] std::string toString() const noexcept;

include/MB/modbusResponse.hpp

@@ -83,12 +83,12 @@ class ModbusResponse {
     /**
      * Copy constructor for the response.
      */
-    ModbusResponse(const ModbusResponse&);
+    ModbusResponse(const ModbusResponse &);
 
     /**
-    * Equal operator for the response.
-    */
-    ModbusResponse& operator=(const ModbusResponse &);
+     * Equal operator for the response.
+     */
+    ModbusResponse &operator=(const ModbusResponse &);
 
     //! Converts object to it's string representation
     [[nodiscard]] std::string toString() const;

include/MB/modbusUtils.hpp

@@ -204,8 +204,7 @@ inline std::string mbFunctionToStr(MBFunctionCode code) noexcept {
 
 //! Create uint16_t from buffer of two bytes, ex. { 0x01, 0x02 } => 0x0102
 inline uint16_t bigEndianConv(const uint8_t *buf) {
-    return static_cast<uint16_t>(buf[1]) +
-           (static_cast<uint16_t>(buf[0]) << 8u);
+    return static_cast<uint16_t>(buf[1]) + (static_cast<uint16_t>(buf[0]) << 8u);
 }
 
 //! @deprecated Calculates CRC - please use functions from `MB::CRC`
@@ -234,7 +233,6 @@ inline void pushUint16(std::vector<uint8_t> &buffer, const uint16_t val) {
 }
 
 //! Ignore some value explicitly
-template<typename T>
-inline void ignore_result(T&& v) { (void)v; }
+template <typename T> inline void ignore_result(T &&v) { (void)v; }
 
 } // namespace MB::utils

src/CMakeLists.txt

@@ -17,16 +17,20 @@ set(CORE_SOURCE_FILES
 )
 
 add_library(Modbus_Core)
-target_sources(Modbus_Core PRIVATE ${CORE_SOURCE_FILES} PUBLIC ${CORE_HEADER_FILES})
+target_sources(Modbus_Core PRIVATE ${CORE_SOURCE_FILES} INTERFACE ${CORE_HEADER_FILES})
 target_include_directories(Modbus_Core PUBLIC ${PROJECT_SOURCE_DIR}/include PRIVATE ${MODBUS_HEADER_FILES_DIR})
 
 add_library(Modbus)
 target_link_libraries(Modbus Modbus_Core)
 
+if(MODBUS_SERIAL_COMMUNICATION)
+    message(STATUS "Enabling Modbus Serial")
+    add_subdirectory(Serial)
+    target_link_libraries(Modbus Modbus_Serial)
+endif()
 
-if(MODBUS_COMMUNICATION)
-    message("Modbus communication is experimental")
+if(MODBUS_TCP_COMMUNICATION)
+    message(STATUS "Enabling Modbus Serial")
     add_subdirectory(TCP)
-    add_subdirectory(Serial)
-    target_link_libraries(Modbus Modbus_TCP Modbus_Serial)
+    target_link_libraries(Modbus Modbus_TCP)
 endif()