Extract OS Detection logic to a header file

Author: f-michaut

CMakeLists.txt

@@ -4,7 +4,7 @@
 ## Author Francois Michaut
 ##
 ## Started on  Sun Aug 28 19:26:51 2022 Francois Michaut
-## Last update Tue May  9 11:51:16 2023 Francois Michaut
+## Last update Wed May 10 08:24:03 2023 Francois Michaut
 ##
 ## CMakeLists.txt : CMake to build the CppSockets library
 ##
@@ -40,5 +40,5 @@ add_custom_target(test
   COMMAND ${CMAKE_COMMAND}
   --build "${CMAKE_CURRENT_BINARY_DIR}/tests" -- --quiet
   COMMAND ${CMAKE_MAKE_PROGRAM}
-  -C "${CMAKE_CURRENT_BINARY_DIR}/tests" test
+  -C "${CMAKE_CURRENT_BINARY_DIR}/tests" test ARGS=--output-on-failure
   )

include/CppSockets/Address.hpp

@@ -4,13 +4,14 @@
 ** Author Francois Michaut
 **
 ** Started on  Sun Feb 13 17:09:05 2022 Francois Michaut
-** Last update Thu Feb  9 08:55:11 2023 Francois Michaut
+** Last update Tue Jul 18 13:34:19 2023 Francois Michaut
 **
 ** Address.hpp : Interface to represent network addresses
 */
 
 #pragma once
 
+#include <cstdint>
 #include <string>
 #include <type_traits>
 

include/CppSockets/OSDetection.hpp

@@ -0,0 +1,26 @@
+/*
+** Project CppSockets, 2023
+**
+** Author Francois Michaut
+**
+** Started on  Tue May  9 23:20:20 2023 Francois Michaut
+** Last update Sun May 14 14:03:20 2023 Francois Michaut
+**
+** OSDetection.hpp : OS Detection macros
+*/
+
+#pragma once
+
+#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
+  #define OS_WINDOWS
+#elif defined (__APPLE__)
+  #define OS_UNIX
+  #define OS_APPLE
+#elif defined(__linux__)
+  #define OS_UNIX
+  #define OS_LINUX
+#elif defined(__unix__)
+  #define OS_UNIX
+#else
+  #error "Unknown compiler, please open a issue or pull request to support your compiler"
+#endif

include/CppSockets/Socket.hpp

@@ -4,21 +4,23 @@
 ** Author Francois Michaut
 **
 ** Started on  Sat Jan 15 01:17:42 2022 Francois Michaut
-** Last update Tue Feb  7 22:31:12 2023 Francois Michaut
+** Last update Tue May  9 23:31:24 2023 Francois Michaut
 **
 ** Socket.hpp : Portable C++ socket class
 */
 
 #pragma once
 
-#ifdef _WIN32
-#define NOMINMAX
-#include <winsock2.h>
-using RawSocketType=SOCKET;
-using socklen_t=int;
+#include "CppSockets/OSDetection.hpp"
+
+#ifdef OS_WINDOWS
+  #define NOMINMAX
+  #include <winsock2.h>
+  using RawSocketType=SOCKET;
+  using socklen_t=int;
 #else
-#include <sys/socket.h>
-using RawSocketType=int;
+  #include <sys/socket.h>
+  using RawSocketType=int;
 #endif
 
 #include <memory>

include/CppSockets/TlsSocket.hpp

@@ -4,19 +4,21 @@
 ** Author Francois Michaut
 **
 ** Started on  Wed Sep 14 20:51:23 2022 Francois Michaut
-** Last update Mon May  8 19:57:05 2023 Francois Michaut
+** Last update Tue May  9 23:29:53 2023 Francois Michaut
 **
 ** SecureSocket.hpp : TLS socket wrapper using openssl
 */
 
 #pragma once
 
-#ifdef _WIN32
+#include "CppSockets/OSDetection.hpp"
+
+#ifdef OS_WINDOWS
 // TODO Currently disabling TlsSocket for windows
 #else
 
 #include "CppSockets/IPv4.hpp"
-#include <CppSockets/Socket.hpp>
+#include "CppSockets/Socket.hpp"
 
 #include <functional>
 

source/Socket.cpp

@@ -4,33 +4,34 @@
 ** Author Francois Michaut
 **
 ** Started on  Sat Jan 15 01:27:40 2022 Francois Michaut
-** Last update Sun Feb 19 11:01:09 2023 Francois Michaut
+** Last update Tue May  9 23:33:46 2023 Francois Michaut
 **
 ** Socket.cpp : Protable C++ socket class implementation
 */
 
-#include <arpa/inet.h>
-#include <cerrno>
-#include <cstring>
-#include <stdexcept>
-#include <unistd.h>
+#include "CppSockets/IPv4.hpp"
+#include "CppSockets/OSDetection.hpp"
+#include "CppSockets/Socket.hpp"
 
-#ifdef _WIN32
-#include <ws2tcpip.h>
+#ifdef OS_WINDOWS
+  #include <ws2tcpip.h>
 #else
-#include <fcntl.h>
-#include <netinet/in.h>
+  #include <fcntl.h>
+  #include <netinet/in.h>
  // To match windows's constants
-static constexpr int INVALID_SOCKET = -1;
-static constexpr int SOCKET_ERROR = -1;
+  static constexpr int INVALID_SOCKET = -1;
+  static constexpr int SOCKET_ERROR = -1;
 #endif
 
 static constexpr int BUFF_SIZE = 4096;
 
 #include <array>
+#include <cerrno>
+#include <cstring>
+#include <stdexcept>
 
-#include "CppSockets/IPv4.hpp"
-#include "CppSockets/Socket.hpp"
+#include <arpa/inet.h>
+#include <unistd.h>
 
 // TODO add exceptions on error retunrs
 // TODO throw custom exceptions on invalid status (eg: socket already connected)
@@ -58,7 +59,7 @@ namespace CppSockets {
     }
 
     Socket::~Socket() {
-#ifdef _WIN32
+#ifdef OS_WINDOWS
         closesocket(raw_socket);
 #else
         close(sockfd);
@@ -79,14 +80,14 @@ namespace CppSockets {
     }
 
     char *Socket::strerror(int err) {
-#ifdef _WIN32
+#ifdef OS_WINDOWS
 #else
         return ::strerror(err);
 #endif
     }
 
     int Socket::get_errno() {
-#ifdef _WIN32
+#ifdef OS_WINDOWS
 #else
         return errno;
 #endif

source/TlsSocket.cpp

@@ -4,17 +4,18 @@
 ** Author Francois Michaut
 **
 ** Started on  Wed Sep 14 21:04:42 2022 Francois Michaut
-** Last update Wed Oct 12 20:10:27 2022 Francois Michaut
+** Last update Tue May  9 23:34:24 2023 Francois Michaut
 **
 ** SecureSocket.cpp : TLS socket wrapper implementation
 */
 
-#ifdef _WIN32
+#include "CppSockets/OSDetection.hpp"
+#include "CppSockets/TlsSocket.hpp"
+
+#ifdef OS_WINDOWS
 // TODO Currently disabling TlsSocket for windows
 #else
 
-#include "CppSockets/TlsSocket.hpp"
-
 #include <openssl/err.h>
 #include <openssl/ssl.h>
 

source/init.cpp

@@ -4,21 +4,23 @@
 ** Author Francois Michaut
 **
 ** Started on  Thu Sep 15 14:24:25 2022 Francois Michaut
-** Last update Thu Sep 15 21:06:20 2022 Francois Michaut
+** Last update Tue May  9 23:34:46 2023 Francois Michaut
 **
 ** init.cpp : Startup/Cleanup functions implementation
 */
 
-#ifdef _WIN32
-#include <winsock2.h>
+#include "CppSockets/OSDetection.hpp"
+
+#ifdef OS_WINDOWS
+  #include <winsock2.h>
 #else
-#include <openssl/err.h>
-#include <openssl/ssl.h>
+  #include <openssl/err.h>
+  #include <openssl/ssl.h>
 #endif
 
 namespace CppSockets {
     void init(bool init_ssl, bool init_wsa) {
-#ifdef _WIN32
+#ifdef OS_WINDOWS
         if (init_wsa) {
             WSADATA wsa_data;
 
@@ -41,7 +43,7 @@ namespace CppSockets {
     }
 
     void deinit(bool deinit_ssl, bool deinit_wsa) {
-#ifdef _WIN32
+#ifdef OS_WINDOWS
         if (deinit_wsa) {
             if (WSACleanup() == SOCKET_ERROR) {
                 // TODO use FormatMessage to get the error string

tests/CMakeLists.txt

@@ -4,7 +4,7 @@
 ## Author Francois Michaut
 ##
 ## Started on  Mon Feb 14 19:35:41 2022 Francois Michaut
-## Last update Sun Aug 28 19:55:12 2022 Francois Michaut
+## Last update Wed May 10 09:47:41 2023 Francois Michaut
 ##
 ## CMakeLists.txt : CMake building and running tests for CppSockets
 ##
@@ -19,14 +19,16 @@ include(CTest)
 
 create_test_sourcelist(TestFiles test_driver.cpp
   TestSockets.cpp
-  )
+)
 
 add_executable(unit_tests
   ../source/Address.cpp
   ../source/Socket.cpp
   ../source/IPv4.cpp
   ${TestFiles}
-  )
+)
+
+target_compile_definitions(unit_tests PRIVATE DEBUG)
 
 foreach (test ${TestFiles})
   if (NOT ${test} STREQUAL test_driver.cpp)