log as option

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-    "C_Cpp.formatting": "Default"
+    "C_Cpp.formatting": "Default",
+    "editor.formatOnSave": true
 }

CMakeLists.txt

@@ -18,6 +18,10 @@ install(FILES
 # BUILD EXAMPLE
 set(EXAMPLE_FILES example/example.cpp)
 add_executable(modbuspp_example ${EXAMPLE_FILES})
+target_compile_definitions(modbuspp_example
+PUBLIC
+    ENABLE_MODBUSPP_LOGGING
+)
 target_include_directories(modbuspp_example
 PUBLIC
     .

README.md

@@ -15,7 +15,8 @@ UPDATES in v0.3 compared to V0.2:
 1. Bug Fixing
 2. Type fixing
 3. Initial Windows support (in dev, not fully tested)
-4. Cmake install script
+4. Logging as Option
+5. Cmake install script
 
 
 # 1 Usage
@@ -41,6 +42,8 @@ Download the MODBUS++, you can:
    and include the code whenever appropriate
    > include "modbuspp/modbus.h"
 
+## 1.3 Logging as Option
+To enable logging, simply set `ENABLE_MODBUSPP_LOGGING` in your compile option, see CMakeLists.txt with example.
 
 # 2 Getting Started with a Example
 ## 2.1 Getting the Example

modbus.h

@@ -6,10 +6,17 @@
 #define MODBUSPP_MODBUS_H
 
 #include <cstring>
-#include <iostream>
 #include <stdint.h>
+#include <string>
 
-#if _WIN32
+#ifdef ENABLE_MODBUSPP_LOGGING
+#include <cstdio>
+#define LOG(fmt, ...) printf("[ modbuspp ]" fmt, ##__VA_ARGS__)
+#else
+#define LOG(...) (void)0
+#endif
+
+#ifdef _WIN32
 // WINDOWS socket
 #define _WINSOCK_DEPRECATED_NO_WARNINGS
 
@@ -165,12 +172,12 @@ bool modbus::modbus_connect()
 {
     if (HOST.empty() || PORT == 0)
     {
-        std::cout << "Missing Host and Port" << std::endl;
+        LOG("Missing Host and Port");
         return false;
     }
     else
     {
-        std::cout << "Found Proper Host " << HOST << " and Port " << PORT << std::endl;
+        LOG("Found Proper Host %s and Port %d", HOST.c_str(), PORT);
     }
 
 #ifdef _WIN32
@@ -183,15 +190,15 @@ bool modbus::modbus_connect()
     _socket = socket(AF_INET, SOCK_STREAM, 0);
     if (!X_ISVALIDSOCKET(_socket))
     {
-        std::cout << "Error Opening Socket" << std::endl;
+        LOG("Error Opening Socket");
 #ifdef _WIN32
         WSACleanup();
 #endif
         return false;
     }
     else
     {
-        std::cout << "Socket Opened Successfully" << std::endl;
+        LOG("Socket Opened Successfully");
     }
 
 #ifdef WIN32
@@ -212,14 +219,14 @@ bool modbus::modbus_connect()
 
     if (!X_ISCONNECTSUCCEED(connect(_socket, (SOCKADDR *)&_server, sizeof(_server))))
     {
-        std::cout << "Connection Error" << std::endl;
+        LOG("Connection Error");
 #ifdef _WIN32
         WSACleanup();
 #endif
         return false;
     }
 
-    std::cout << "Connected" << std::endl;
+    LOG("Connected");
     _connected = true;
     return true;
 }
@@ -233,7 +240,7 @@ void modbus::modbus_close() const
 #ifdef _WIN32
     WSACleanup();
 #endif
-    std::cout << "Socket Closed" << std::endl;
+    LOG("Socket Closed");
 }
 
 /**